{
  "type": "object",
  "example": {},
  "properties": {}
}

{
  "type": "object",
  "title": "CarrierParcelTemplate represents the fields of a template before saving it to the db.",
  "properties": {
    "name": {
      "type": "string",
      "example": "FedEx® Small Box (S1)",
      "description": "The name of the carrier parcel template"
    },
    "token": {
      "type": "string",
      "example": "FedEx_Box_Small_1",
      "description": "The unique string representation of the carrier parcel template"
    },
    "width": {
      "type": "string",
      "example": "10.875",
      "description": "The width of the package, in units specified by the distance_unit attribute"
    },
    "height": {
      "type": "string",
      "example": "1.5",
      "description": "The height of the package, in units specified by the distance_unit attribute"
    },
    "length": {
      "type": "string",
      "example": "12.375",
      "description": "The length of the package, in units specified by the distance_unit attribute"
    },
    "carrier": {
      "type": "string",
      "example": "FedEx",
      "description": "The name of the carrier that provides this parcel template"
    },
    "distance_unit": {
      "$ref": "#/components/schemas/DistanceUnitEnum"
    },
    "is_variable_dimensions": {
      "type": "string",
      "example": "false",
      "description": "True if the carrier parcel template allows custom dimensions, such as USPS Softpack."
    }
  }
}

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/CarrierParcelTemplate"
  }
}

{
  "enum": [
    "airterra",
    "apc_postal",
    "apg",
    "aramex",
    "asendia_us",
    "australia_post",
    "axlehire",
    "better_trucks",
    "borderguru",
    "boxberry",
    "bring",
    "canada_post",
    "cdl",
    "chronopost",
    "collect_plus",
    "correios_br",
    "correos_espana",
    "couriersplease",
    "colissimo",
    "deutsche_post",
    "dhl_benelux",
    "dhl_ecommerce",
    "dhl_express",
    "dhl_germany_c2c",
    "dhl_germany",
    "dpd_de",
    "dpd_uk",
    "estafeta",
    "fastway_australia",
    "fedex",
    "globegistics",
    "gls_us",
    "gophr",
    "gso",
    "hermes_germany_b2c",
    "hermes_uk",
    "hongkong_post",
    "lasership",
    "lso",
    "mondial_relay",
    "new_zealand_post",
    "nippon_express",
    "ontrac",
    "orangeds",
    "parcelforce",
    "parcel",
    "passport",
    "pcf",
    "poste_italiane",
    "posti",
    "purolator",
    "royal_mail",
    "rr_donnelley",
    "russian_post",
    "sendle",
    "skypostal",
    "stuart",
    "swyft",
    "uds",
    "ups",
    "usps",
    "veho",
    "x_delivery",
    "yodel"
  ],
  "type": "string",
  "description": "|Token | Carrier name|\n|:---|:---|\n| airterra | Airterra |\n| apc_postal | APC Postal|\n| apg | APG|\n| aramex | Aramex|\n| asendia_us | Asendia US|\n| australia_post | Australia Post (also used for Startrack)|\n| axlehire | Axlehire|\n| better_trucks | BetterTrucks|\n| borderguru | BorderGuru|\n| boxberry | Boxberry|\n| bring | Bring (also used for Posten Norge)|\n| canada_post | Canada Post|\n| cdl | CDL|\n| chronopost | Chronopost|\n| collect_plus | CollectPlus|\n| correios_br | CorreiosBR|\n| correos_espana | Correos España |\n| couriersplease | Couriers Please|\n| colissimo | Colissimo|\n| deutsche_post | Deutsche Post|\n| dhl_benelux | DHL Benelux|\n| dhl_ecommerce | DHL eCommerce|\n| dhl_express | DHL Express|\n| dhl_germany_c2c | DHL Germany C2C|\n| dhl_germany | DHL Germany|\n| dpd_de | DPD GERMANY|\n| dpd_uk | DPD UK|\n| estafeta | Estafeta|\n| fastway_australia | Aramex|\n| fedex | FedEx|\n| globegistics | Globegistics (now Asendia)|\n| gls_us | GLS US|\n| gophr | Gophr|\n| gso | GSO|\n| hermes_germany_b2c | Hermes Germany B2C|\n| hermes_uk | Evri UK |\n| hongkong_post | Hongkong Post|\n| lasership | LaserShip|\n| lso | LSO|\n| mondial_relay | Mondial Relay|\n| new_zealand_post | New Zealand Post (also used for Pace and CourierPost)|\n| nippon_express | Nippon Express|\n| ontrac | OnTrac|\n| orangeds | OrangeDS|\n| parcelforce | Parcelforce|\n| parcel | Parcel|\n| passport | Passport|\n| pcf | PCF|\n| poste_italiane | Poste Italiane |\n| posti | Posti|\n| purolator | Purolator|\n| royal_mail | Royal Mail|\n| rr_donnelley | ePost Global|\n| russian_post | Russian Post|\n| sendle | Sendle|\n| skypostal | SkyPostal|\n| stuart | Stuart|\n| swyft | Swyft|\n| uds | UDS (United Delivery Service)|\n| ups | UPS|\n| usps | USPS|\n| veho | Veho |\n| x_delivery | X Delivery (now Maergo)|\n| yodel | Yodel|\n"
}

{
  "title": "Account parameters",
  "description": "An array of additional parameters for the account, such as e.g. password or token. Please check our \n<a href=\"https://docs.goshippo.com/docs/carriers/carrieraccounts/\">carrier accounts guide</a> \nfor the parameters per carrier.\nTo protect account information, this field will be masked in any API response.\n",
  "additionalProperties": true
}

{
  "type": "object",
  "title": "Account parameters",
  "required": [
    "carrier",
    "account_id",
    "parameters"
  ],
  "properties": {
    "test": {
      "type": "boolean",
      "example": false
    },
    "active": {
      "type": "boolean"
    },
    "carrier": {
      "type": "string",
      "example": "fedex"
    },
    "metadata": {
      "type": "string",
      "example": "FEDEX Account"
    },
    "account_id": {
      "type": "string",
      "example": "321123"
    },
    "parameters": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/ConnectExistingOwnAccountParameters"
        },
        {
          "$ref": "#/components/schemas/UPSConnectExistingOwnAccountParameters"
        }
      ]
    }
  }
}

{
  "type": "object",
  "properties": {
    "rate": {
      "type": "string",
      "example": "0.89",
      "description": "Currency conversion rate, relative to USD, that was used to calculate the converted amount."
    },
    "time": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time the currency conversion took place."
    },
    "amount": {
      "type": "string",
      "example": "4.91",
      "description": "The money amount after currency conversion."
    },
    "currency": {
      "type": "string",
      "example": "USD",
      "description": "The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. \"USD\" or \"EUR\".\n<a href=\"http://www.xe.com/iso4217.php\" target=\"blank\">ISO 4217 Standard</a>."
    }
  },
  "description": "Invoice Item's amount after currency conversion took place."
}

{
  "type": "object",
  "required": [
    "account_id",
    "parameters",
    "active"
  ],
  "properties": {
    "test": {
      "type": "boolean",
      "example": false
    },
    "active": {
      "type": "boolean"
    },
    "carrier": {
      "type": "string",
      "example": "ups"
    },
    "metadata": {
      "type": "string",
      "example": "UPS Account"
    },
    "account_id": {
      "type": "string",
      "description": "This field is required as input to the API, but is not used for UPS. Use the empty string."
    },
    "parameters": {
      "$ref": "#/components/schemas/UPSCreateNewOwnAccountParameters"
    }
  }
}

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "Optional text to be printed on the shipping label for customer reference. Up to 40 characters. If \nthis is provided, reference_1 will be ignored."
    },
    "prefix": {
      "type": "string",
      "description": "Custom prefix for customer reference field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property."
    }
  },
  "description": "Specify the reference field on the label (FedEx only)."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/CustomsDeclarationBase"
    },
    {
      "required": [
        "items"
      ],
      "properties": {
        "test": {
          "type": "boolean",
          "example": true,
          "description": "Indicates whether the object has been created in test mode."
        },
        "items": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "5087f181d1dc4b14b73fdbf636498886"
          ],
          "description": "Distinct Parcel content items as Customs Items object_ids."
        },
        "object_id": {
          "type": "string",
          "example": "e2197a54da9d470480f4f8796cc419cb",
          "description": "Unique identifier of the given object."
        },
        "object_owner": {
          "type": "string",
          "example": "shippotle@shippo.com",
          "description": "Username of the user who created the object."
        },
        "object_state": {
          "$ref": "#/components/schemas/ObjectStateEnum"
        },
        "object_created": {
          "type": "string",
          "format": "date-time",
          "example": "2014-07-17T01:01:08.306Z",
          "description": "Date and time of object creation."
        },
        "object_updated": {
          "type": "string",
          "format": "date-time",
          "example": "2014-07-17T01:01:08.306Z",
          "description": "Date and time of last object update."
        },
        "address_importer": {
          "type": "object",
          "example": "257ba08436604d2aaf069caafe7acb2a",
          "description": "Object ID of the Importer address."
        },
        "invoiced_charges": {
          "$ref": "#/components/schemas/CustomsInvoicedCharges"
        },
        "exporter_identification": {
          "$ref": "#/components/schemas/CustomsExporterIdentification"
        }
      }
    }
  ]
}

{
  "enum": [
    "FILED_ELECTRONICALLY",
    "SUMMARY_REPORTING",
    "NOT_REQUIRED"
  ],
  "type": "string",
  "description": "B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). \n<a href=\"https://www.cbsa-asfc.gc.ca/services/export/guide-eng.html\" target=\"_blank\" rel=\"noopener noreferrer\"> More information on reporting commercial exports from Canada. </a>"
}

{
  "type": "object",
  "required": [
    "certify_signer",
    "certify",
    "non_delivery_option",
    "contents_type"
  ],
  "properties": {
    "notes": {
      "type": "string",
      "description": "Additional notes to be included in the customs declaration."
    },
    "aes_itn": {
      "type": "string",
      "description": "**required if eel_pfc is `AES_ITN`**<br>\nAES / ITN reference of the shipment."
    },
    "certify": {
      "type": "boolean",
      "example": true,
      "description": "Expresses that the certify_signer has provided all information of this customs declaration truthfully."
    },
    "eel_pfc": {
      "$ref": "#/components/schemas/CustomsDeclarationEelPfcEnum"
    },
    "invoice": {
      "type": "string",
      "example": "#123123",
      "description": "Invoice reference of the shipment."
    },
    "license": {
      "type": "string",
      "description": "License reference of the shipment."
    },
    "incoterm": {
      "$ref": "#/components/schemas/CustomsDeclarationIncotermEnum"
    },
    "metadata": {
      "type": "string",
      "example": "Order ID #123123",
      "description": "A string of up to 100 characters that can be filled with any additional information you \nwant to attach to the object."
    },
    "disclaimer": {
      "type": "string",
      "description": "Disclaimer for the shipment and customs information that have been provided."
    },
    "b13a_number": {
      "type": "string",
      "description": "**must be provided if and only if b13a_filing_option is provided**<br>\nRepresents:<br> the Proof of Report (POR) Number when b13a_filing_option is `FILED_ELECTRONICALLY`;<br> \nthe Summary ID Number when b13a_filing_option is `SUMMARY_REPORTING`;<br> \nor the Exemption Number when b13a_filing_option is `NOT_REQUIRED`."
    },
    "certificate": {
      "type": "string",
      "description": "Certificate reference of the shipment."
    },
    "contents_type": {
      "$ref": "#/components/schemas/CustomsDeclarationContentsTypeEnum"
    },
    "certify_signer": {
      "type": "string",
      "example": "Shawn Ippotle",
      "description": "Name of the person who created the customs declaration and is responsible for the validity of all \ninformation provided."
    },
    "is_vat_collected": {
      "description": "Indicates whether the shipment's destination VAT has been collected. May be required for some destinations."
    },
    "b13a_filing_option": {
      "$ref": "#/components/schemas/CustomsDeclarationB13AFilingOptionEnum"
    },
    "commercial_invoice": {
      "type": "string"
    },
    "exporter_reference": {
      "type": "string",
      "description": "Exporter reference of an export shipment."
    },
    "importer_reference": {
      "type": "string",
      "description": "Importer reference of an import shipment."
    },
    "non_delivery_option": {
      "$ref": "#/components/schemas/CustomsDeclarationNonDeliveryOptionEnum"
    },
    "contents_explanation": {
      "type": "string",
      "example": "T-Shirt purchase",
      "description": "**required if contents_type is `OTHER`**<br>\nExplanation of the type of goods of the shipment."
    }
  }
}

{
  "enum": [
    "DOCUMENTS",
    "GIFT",
    "SAMPLE",
    "MERCHANDISE",
    "HUMANITARIAN_DONATION",
    "RETURN_MERCHANDISE",
    "OTHER"
  ],
  "type": "string",
  "example": "MERCHANDISE",
  "description": "Type of goods of the shipment."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/CustomsDeclarationBase"
    },
    {
      "required": [
        "items"
      ],
      "properties": {
        "test": {
          "type": "boolean",
          "example": true
        },
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CustomsItemBase"
          }
        },
        "address_importer": {
          "$ref": "#/components/schemas/AddressImporter"
        }
      }
    }
  ]
}

{
  "enum": [
    "NOEEI_30_37_a",
    "NOEEI_30_37_h",
    "NOEEI_30_37_f",
    "NOEEI_30_36",
    "AES_ITN"
  ],
  "type": "string",
  "example": "NOEEI_30_37_a",
  "description": "EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most \nother shipments from the US, `NOEEI_30_37_a` is applicable."
}

{
  "enum": [
    "DDP",
    "DDU",
    "FCA",
    "DAP",
    "eDAP"
  ],
  "type": "string",
  "example": "DDP",
  "description": "The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. \neDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK.\nIf expecting DAP for other carriers, please use DDU."
}

{
  "enum": [
    "ABANDON",
    "RETURN"
  ],
  "type": "string",
  "description": "Indicates how the carrier should proceed in case the shipment can't be delivered."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PaginatedList"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CustomsDeclaration"
          }
        }
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "tax_id": {
      "$ref": "#/components/schemas/CustomsTaxIdentification"
    },
    "eori_number": {
      "type": "string",
      "example": "PL123456790ABCDE",
      "description": "Economic Operators' Registration and Identification (EORI) number. Must start with a 2 character \ncountry code followed by a 6-17 character alphanumeric identifier (e.g. PL1234567890ABCDE).\n<a href=\"https://ec.europa.eu/taxation_customs/business/customs-procedures/general-overview/economic-operators-registration-identification-number-eori_en\">More information on EORI.</a>"
    }
  },
  "description": "Additional exporter identification that may be required to ship in certain countries"
}

{
  "type": "object",
  "required": [
    "currency"
  ],
  "properties": {
    "currency": {
      "type": "string",
      "format": "iso-4217",
      "description": "Currency for the invoiced charges amounts incurred on the end consumer."
    },
    "other_fees": {
      "type": "string",
      "description": "Other fees paid by the buyer."
    },
    "total_taxes": {
      "type": "string",
      "description": "Total taxes paid by the buyer."
    },
    "total_duties": {
      "type": "string",
      "description": "Total duties paid by the buyer."
    },
    "total_shipping": {
      "type": "string",
      "description": "Total shipping paid by the buyer."
    }
  },
  "description": "Additional invoiced charges to be shown on the Customs Declaration Commercial Invoice."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/CustomsItemBase"
    },
    {
      "properties": {
        "test": {
          "type": "boolean",
          "description": "Indicates whether the object has been created in test mode."
        },
        "object_id": {
          "type": "string",
          "example": "d799c2679e644279b59fe661ac8fa488",
          "description": "Unique identifier of the given object."
        },
        "object_owner": {
          "type": "string",
          "example": "shippotle@shippo.com",
          "description": "Username of the user who created the object."
        },
        "object_state": {
          "$ref": "#/components/schemas/ObjectStateEnum"
        },
        "object_created": {
          "type": "string",
          "format": "date-time",
          "example": "2014-07-17T00:49:20.631Z",
          "description": "Date and time of object creation."
        },
        "object_updated": {
          "type": "string",
          "format": "date-time",
          "example": "2014-07-17T00:49:20.631Z",
          "description": "Date and time of last object update."
        }
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "description",
    "quantity",
    "net_weight",
    "mass_unit",
    "value_amount",
    "value_currency",
    "origin_country"
  ],
  "properties": {
    "metadata": {
      "type": "string",
      "example": "Order ID \"123454\"",
      "description": "A string of up to 100 characters that can be filled with any additional information you \nwant to attach to the object."
    },
    "quantity": {
      "type": "integer",
      "format": "int64",
      "example": 20,
      "description": "Quantity of this item in the shipment you send.  Must be greater than 0."
    },
    "sku_code": {
      "type": "string",
      "example": "HM-123",
      "description": "SKU code of the item, which is required by some carriers."
    },
    "mass_unit": {
      "$ref": "#/components/schemas/WeightUnitEnum"
    },
    "eccn_ear99": {
      "type": "string",
      "description": "Export Control Classification Number, required on some exports from the United States."
    },
    "net_weight": {
      "type": "string",
      "example": "5",
      "description": "Total weight of this item, i.e. quantity * weight per item."
    },
    "description": {
      "type": "string",
      "example": "T-Shirt",
      "description": "Text description of your item."
    },
    "value_amount": {
      "type": "string",
      "example": "200",
      "description": "Total value of this item, i.e. quantity * value per item."
    },
    "tariff_number": {
      "type": "string",
      "description": "The tariff number of the item."
    },
    "origin_country": {
      "type": "string",
      "description": "Country of origin of the item. Example: `US` or `DE`. \nAll accepted values can be found on the <a href=\"http://www.iso.org/\" target=\"_blank\">Official ISO Website</a>."
    },
    "value_currency": {
      "type": "string",
      "example": "USD",
      "description": "Currency used for value_amount. The <a href=\"http://www.xe.com/iso4217.php\">official ISO 4217</a> \ncurrency codes are used, e.g.  `USD` or `EUR`."
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PaginatedList"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CustomsItem"
          }
        }
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "type": {
      "enum": [
        "EIN",
        "VAT",
        "IOSS",
        "ARN"
      ],
      "type": "string",
      "example": "EIN",
      "description": "Type of tax identification.\n* `EIN` - Employer Identification Number, also known as a Federal Tax Identification Number.\n* `VAT` - Value Added Tax identification number.\n* `IOSS` - Import One-Stop Shop\n* `ARN` - Australian Taxation Office Reference Number"
    },
    "number": {
      "type": "string",
      "example": "123456789",
      "description": "Tax identification number."
    }
  },
  "description": "Tax identification that may be required to ship in certain countries. Typically used to assess duties on \ngoods that are crossing a border."
}

{
  "type": "object",
  "properties": {
    "contains": {
      "type": "boolean",
      "description": "Indicates if the shipment contains biological material."
    }
  },
  "description": "Container for specifying the presence of biological material."
}

{
  "type": "object",
  "properties": {
    "contains": {
      "type": "boolean",
      "description": "Indicates if the shipment contains lithium batteries."
    }
  },
  "description": "Container for specifying the presence of lithium batteries."
}

{
  "type": "object",
  "properties": {
    "contains": {
      "type": "boolean",
      "description": "Indicates if the shipment contains dangerous goods."
    },
    "lithium_batteries": {
      "$ref": "#/components/schemas/DangerousGoodsLithiumBatteries"
    },
    "biological_material": {
      "$ref": "#/components/schemas/DangerousGoodsBiologicalMaterial"
    }
  },
  "description": "Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents\nare provided, only certain USPS service levels will be eligible. For more information, see our\n<a href=\"https://docs.goshippo.com/docs/shipments/hazmat/\">guide on hazardous or dangerous materials shipping</a>."
}

{
  "type": "object",
  "properties": {
    "result": {
      "$ref": "#/components/schemas/UserParcelTemplate"
    }
  }
}

{
  "type": "object",
  "properties": {
    "object_id": {
      "type": "string",
      "example": "b958d3690bb04bb8b2986724872750f5"
    }
  }
}

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "Optional text to be printed on the shipping label for department number. Up to 40 characters."
    },
    "prefix": {
      "type": "string",
      "description": "Custom prefix for department number field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property."
    }
  },
  "description": "Specify the department number field on the label (FedEx only)."
}

{
  "enum": [
    "cm",
    "in",
    "ft",
    "m",
    "mm",
    "yd"
  ],
  "type": "string",
  "example": "in",
  "description": "The measure unit used for length, width and height."
}

{
  "type": "object",
  "properties": {
    "weight": {
      "type": "string",
      "description": "Mandatory. Units must be in Kilograms. Cannot be greater than package weight."
    },
    "contains_dry_ice": {
      "type": "boolean",
      "description": "Mandatory. Specifies that the package contains Dry Ice."
    }
  },
  "description": "Specify that the package contains Dry Ice (FedEx, Veho, and UPS only)."
}

{
  "type": "object",
  "properties": {
    "shipment": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "example": [
        {
          "address_to": [
            "This field is required."
          ]
        }
      ]
    }
  }
}

{
  "type": "object",
  "required": [
    "shipment",
    "carrier_account",
    "servicelevel_token"
  ],
  "properties": {
    "metadata": {
      "type": "string",
      "example": "Order ID #12345"
    },
    "shipment": {
      "$ref": "#/components/schemas/ShipmentCreateRequest"
    },
    "carrier_account": {
      "type": "string",
      "example": "b741b99f95e841639b54272834bc478c"
    },
    "label_file_type": {
      "$ref": "#/components/schemas/LabelFileTypeEnum"
    },
    "servicelevel_token": {
      "type": "string",
      "example": "usps_priority"
    }
  }
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "example": "5.5",
      "description": "Declared value of the goods you want to insure."
    },
    "content": {
      "type": "string",
      "description": "Description of package content."
    },
    "currency": {
      "type": "string",
      "format": "iso-4217",
      "example": "USD",
      "description": "Currency for the amount value.\nCurrently only USD is supported for FedEx and UPS."
    },
    "provider": {
      "enum": [
        "FEDEX",
        "UPS",
        "ONTRAC"
      ],
      "type": "string",
      "description": "To have insurance cover provided by a carrier directly instead of Shippo's provider (XCover), set `provider` to `FEDEX`, `UPS`, or `ONTRAC`."
    }
  },
  "description": "To add 3rd party insurance powered by <a href=\"https://docs.goshippo.com/docs/shipments/shippinginsurance/\">XCover</a>, specify <br> `amount`, `content`, and `currency`. <br> Alternatively, you can choose carrier provided insurance by additionally specifying `provider` (UPS, FedEx and OnTrac only). <br><br> If you do not want to add insurance to you shipment, do not set these parameters."
}

{
  "type": "object",
  "properties": {
    "status": {
      "$ref": "#/components/schemas/InvoiceStatusEnum"
    },
    "object_id": {
      "type": "string",
      "example": "ec9f0d3adc9441449c85d315f0997fd5",
      "description": "Unique identifier of the given Invoice object"
    },
    "total_charged": {
      "$ref": "#/components/schemas/AmountAndCurrencyCharged"
    },
    "invoice_closed": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of when the Invoice was posted and no new Invoice Items were added. Field will be null when invoice is still in the draft status."
    },
    "invoice_number": {
      "type": "string",
      "example": 234167,
      "description": "Human readable unique identifier of the given Invoice object that is displayed in the web app."
    },
    "object_created": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of Invoice creation."
    },
    "object_updated": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of last Invoice update."
    },
    "shippo_account": {
      "type": "string",
      "example": "915d94940ea54c3a80cbfa328722f5a1",
      "description": "Unique identifier of the user who the Invoice has been issued to."
    },
    "total_invoiced": {
      "$ref": "#/components/schemas/AmountAndCurrencyInvoiced"
    },
    "invoice_paid_date": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of when the Invoice was successfully paid. Field will be null when invoice is not in the paid status."
    }
  }
}

{
  "type": "object",
  "properties": {
    "type": {
      "$ref": "#/components/schemas/InvoiceItemTypesEnum",
      "type": "string",
      "example": "SUBSCRIPTION_PLAN_FEE"
    },
    "amount": {
      "type": "string",
      "example": "5.54",
      "description": "The money amount that the Invoice Item represents."
    },
    "invoice": {
      "type": "string",
      "example": "011044d8405e43bd8b1efe1c21f967df",
      "description": "Unique identifier of the Invoice that the Invoice Item belongs to."
    },
    "currency": {
      "type": "string",
      "example": "USD",
      "description": "The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. \"USD\" or \"EUR\".\n<a href=\"http://www.xe.com/iso4217.php\" target=\"blank\">ISO 4217 Standard</a>."
    },
    "object_id": {
      "type": "string",
      "example": "ec9f0d3adc9441449c85d315f0997fd5",
      "description": "Unique identifier of the given Invoice Item object."
    },
    "description": {
      "type": "string",
      "example": "monthly subscription plan fee for 2019-08-24",
      "description": "Additional information about what the Invoice Item is for."
    },
    "transaction": {
      "type": "string",
      "example": "915d94940ea54c3a80cbfa328722f5a1",
      "description": "Unique identifier of the Transaction that the Invoice Item represents. Not all Invoice Items are linked to a transaction."
    },
    "object_created": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of Invoice Item creation."
    },
    "object_updated": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time of last Invoice Item update."
    },
    "shippo_account": {
      "type": "string",
      "example": "915d94940ea54c3a80cbfa328722f5a1",
      "description": "Unique identifier of the user who the Invoice Item has been issued to."
    },
    "charge_conversion": {
      "$ref": "#/components/schemas/ConversionAmount"
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PaginatedList"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/InvoiceItem"
          }
        }
      }
    }
  ]
}

{
  "enum": [
    "LABEL_PAYMENT",
    "LABEL_SURCHARGE",
    "LABEL_REFUND",
    "ONE_OFF_CREDIT",
    "TRACK_FEE",
    "ADDRESS_VALIDATION_FEE",
    "SUBSCRIPTION_PLAN_FEE",
    "PROMO_CODE_CREDIT",
    "PREAUTH_CAPTURE",
    "LABEL_PAYMENT_ADJUSTMENT",
    "LABEL_REFUND_ADJUSTMENT"
  ],
  "type": "string",
  "description": "The type of the Invoice Item.\n|Type| Description|\n|:---|:---|\n| LABEL_PAYMENT | Invoice Item for the payment of a label. |\n| LABEL_SURCHARGE | Invoice Item for a surcharge of a label. See <a href=\"https://support.goshippo.com/hc/en-us/articles/115004734443-Understanding-Postal-Surcharges-in-Shippo\"> here </a> for more information. |\n| LABEL_REFUND | Invoice Item for a refund of a label. |\n| ONE_OFF_CREDIT | Invoice Item for credit given by Shippo. |\n| TRACK_FEE | Invoice Item for fees associated with tracking services. |\n| ADDRESS_VALIDATION_FEE | Invoice Item for fees associated with global address validation services. |\n| SUBSCRIPTION_PLAN_FEE | Invoice Item for subscription plan fees. |\n| PROMO_CODE_CREDIT | Invoice Item for promotional code related credits. |\n| PREAUTH_CAPTURE | Invoice Item for preauthorization capture. Represents a credit. See <a href=\"https://support.goshippo.com/hc/en-us/articles/4407966198171-Pre-Authorization-Charges-for-New-Accounts-in-Shippo\"> here </a> for more information. |\n| LABEL_PAYMENT_ADJUSTMENT | Invoice Item for adjustments on label purchases. |\n| LABEL_REFUND_ADJUSTMENT | Invoice Item for adjustments on label refunds. |\n"
}

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "Optional text to be printed on the shipping label for invoice number. Up to 40 characters. If \nprovided, this will be used on the label instead of shipment.customs_declaration.invoice."
    },
    "prefix": {
      "type": "string",
      "description": "Custom prefix for invoice number field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property."
    }
  },
  "description": "Specify the invoice number field on the label (FedEx only)."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PaginatedList"
    },
    {
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Invoice"
          }
        }
      }
    }
  ]
}

{
  "enum": [
    "DRAFT",
    "POSTED",
    "PAID",
    "UNCOLLECTIBLE",
    "VOID"
  ],
  "type": "string",
  "example": "POSTED",
  "description": "The status of the Invoice."
}

{
  "enum": [
    "PNG",
    "PNG_2.3x7.5",
    "PDF",
    "PDF_2.3x7.5",
    "PDF_4x6",
    "PDF_4x8",
    "PDF_A4",
    "PDF_A5",
    "PDF_A6",
    "ZPLII"
  ],
  "type": "string",
  "example": "PDF_4x6",
  "description": "Print format of the <a href=\"https://docs.goshippo.com/docs/shipments/shippinglabelsizes/\">label</a>. If empty, will use the default format set from \n<a href=\"https://apps.goshippo.com/settings/labels\">the Shippo dashboard.</a>"
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/LineItemBase"
    },
    {
      "properties": {
        "object_id": {
          "type": "string",
          "example": "abf7d5675d744b6ea9fdb6f796b28f28",
          "description": "Unique identifier of the line item object."
        }
      }
    }
  ]
}

{
  "type": "object",
  "properties": {
    "sku": {
      "type": "string",
      "example": "HM-123",
      "description": "The stock keeping unit value of this item."
    },
    "title": {
      "type": "string",
      "example": "Hippo Magazines",
      "description": "Title of the line item."
    },
    "weight": {
      "type": "string",
      "example": "0.4",
      "description": "Total weight of this/these item(s). Instead of specifying the weight of all items, \nyou can also set the <code>total_weight</code> value of the order object."
    },
    "currency": {
      "type": "string",
      "example": "USD",
      "description": "Currency of the <code>total_price</code> amount."
    },
    "quantity": {
      "type": "integer",
      "format": "int64",
      "example": 20,
      "description": "The quantity of this item in this order."
    },
    "total_price": {
      "type": "string",
      "example": "12.1",
      "description": "Total price paid by the buyer for this item (or these items, if quantity > 1)."
    },
    "weight_unit": {
      "$ref": "#/components/schemas/WeightUnitEnum"
    },
    "max_ship_time": {
      "type": "string",
      "format": "date-time",
      "example": "2016-07-23T00:00:00Z",
      "description": "The date and time this item needs to be fulfilled by, i.e. by when the shipping label needs to be \ncreated and handed over to the carrier. This value is used by some platforms such as eBay to measure \na seller's handling time and performance. It will be displayed in the Shippo dashboard."
    },
    "variant_title": {
      "type": "string",
      "example": "June Edition",
      "description": "A variant is a specific variation of an item (e.g. `size M` or `color blue`). \nVariants might be exposed as a separate resource in the future too. \nCurrently the variant title is a free text field describing the variant."
    },
    "max_delivery_time": {
      "type": "string",
      "format": "date-time",
      "example": "2016-07-23T00:00:00Z",
      "description": "The date and time this item needs to be delivered by, i.e. by when the carrier delivers it to the buyer. \nThis value is used by some platforms such as eBay to measure a seller's shipping time and performance. \nIt will be displayed in the Shippo dashboard."
    },
    "manufacture_country": {
      "type": "string",
      "example": "US",
      "description": "Country the item was manufactured in. In the Shippo dashboard, this value will be used ot pre-fill the customs declaration when creating a label for this order."
    }
  }
}

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "example": "Shipping Option 1",
      "description": "The name of the service group being returned"
    },
    "amount": {
      "type": "string",
      "example": "12.34",
      "description": "The value of the price for the service group, in units of currency of the sender address"
    },
    "currency": {
      "type": "string",
      "example": "USD",
      "description": "The ISO 4217 currency code for the price"
    },
    "amount_local": {
      "type": "string",
      "example": "15.48",
      "description": "The value of the price for the service group, in the currency of the destination address"
    },
    "currency_local": {
      "type": "string",
      "example": "CAD",
      "description": "The ISO 4217 currency code for the currency describing amount_local"
    },
    "estimated_days": {
      "type": "integer",
      "format": "int64",
      "example": 2,
      "description": "The estimated days in transit of the rate that powers the shipping option, if available."
    }
  }
}

{
  "type": "object",
  "required": [
    "address_to",
    "line_items"
  ],
  "properties": {
    "parcel": {
      "oneOf": [
        {
          "type": "string",
          "description": "Object ID for an existing User Parcel Template"
        },
        {
          "$ref": "#/components/schemas/Parcel"
        }
      ],
      "example": "5df144dca289442cv7a06",
      "description": "Object ID for an existing User Parcel Template OR a fully formed Parcel object."
    },
    "address_to": {
      "oneOf": [
        {
          "type": "string",
          "description": "Object ID for an existing <a href=\"#tag/Addresses\">Address</a>"
        },
        {
          "$ref": "#/components/schemas/AddressCompleteCreateRequest"
        }
      ],
      "description": "The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, \ncountry, phone number, and email address (strings). Special characters should not be included in \nany address element, especially name, company, and email."
    },
    "line_items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LineItem"
      },
      "description": "Array of Line Item objects"
    },
    "address_from": {
      "oneOf": [
        {
          "type": "string",
          "description": "Object ID for an existing <a href=\"#tag/Addresses\">Address</a>"
        },
        {
          "$ref": "#/components/schemas/AddressCompleteCreateRequest"
        }
      ],
      "description": "The sender address, which includes your name, company name, street address, city, state, zip code, \ncountry, phone number, and email address (strings). Special characters should not be included in \nany address element, especially name, company, and email."
    }
  }
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/PaginatedList"
    },
    {
      "properties": {
        "count": {
          "type": "integer",
          "format": "int64",
          "example": 123
        },
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/LiveRate"
          }
        }
      }
    }
  ]
}

{
  "type": "object",
  "required": [
    "building_location_type",
    "address"
  ],
  "properties": {
    "address": {
      "$ref": "#/components/schemas/AddressCompleteCreateRequest"
    },
    "instructions": {
      "type": "string",
      "example": "Behind screen door",
      "description": "Pickup instructions for the courier. This is a mandatory field if the building_location_type is \"Other\"."
    },
    "building_type": {
      "enum": [
        "apartment",
        "building",
        "department",
        "floor",
        "room",
        "suite"
      ],
      "type": "string",
      "example": "apartment",
      "description": "The type of building where the pickup is located."
    },
    "building_location_type": {
      "enum": [
        "Back Door",
        "Ring Bell",
        "Security Deck",
        "Shipping Dock",
        "Front Door",
        "Knock on Door",
        "In/At Mailbox",
        "Mail Room",
        "Office",
        "Other",
        "Reception",
        "Side Door"
      ],
      "type": "string",
      "example": "Front Door",
      "description": "Where your parcels will be available for pickup. \"Security Deck\" and \"Shipping Dock\" are only \nsupported for DHL Express."
    }
  },
  "description": "Location where the parcel(s) will be picked up."
}

{
  "allOf": [
    {
      "$ref": "#/components/schemas/ManifestBase"
    },
    {
      "required": [
        "status",
        "object_created",
        "object_updated",
        "object_id",
        "object_owner",
        "documents",
        "address_from"
      ],
      "properties": {
        "errors": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "An array of codes and messages describing the error that occurred if any."
        },
        "status": {
          "enum": [
            "QUEUED",
            "SUCCESS",
            "ERROR"
          ],
          "type": "string",
          "example": "SUCCESS",
          "description": "Indicates the status of the manifest."
        },
        "documents": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "https://shippo-delivery.s3.amazonaws.com/0fadebf6f60c4aca95fa01bcc59c79ae.pdf?Signature=tlQU3RECwdHUQJQadwqg5bAzGFQ%3D&Expires=1402803835&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA"
          ],
          "description": "An array containing the URLs to all returned manifest documents."
        },
        "object_id": {
          "type": "string",
          "example": "adcfdddf8ec64b84ad22772bce3ea37a",
          "description": "Unique identifier of the given object."
        },
        "address_from": {
          "type": "string",
          "example": "d799c2679e644279b59fe661ac8fa488",
          "description": "ID of the Address object that should be used as pickup address for the scan form. \nThe USPS will validate this address before creating the scan form."
        },
        "object_owner": {
          "type": "string",
          "example": "shippotle@shippo.com",
          "description": "Username of the user who created the object."
        },
        "object_created": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time of object creation."
        },
        "object_updated": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time of last object update."
        }
      }
    }
  ]
}