> ## Documentation Index > Fetch the complete documentation index at: https://docs.goshippo.com/llms.txt > Use this file to discover all available pages before exploring further. # List all shipments > Returns a list of all shipment objects.

In order to filter results, you must use the below path parameters. Provided dates should be ISO 8601 UTC dates (timezone offsets are currently not supported).

Optional path parameters:
`object_created_gt`- object(s) created greater than a provided date time
`object_created_gte` - object(s) created greater than or equal to a provided date time
`object_created_lt` - object(s) created less than a provided date time
`object_created_lte` - object(s) created less than or equal to a provided date time
Date format examples:
`2017-01-01`
`2017-01-01T03:30:30` or `2017-01-01T03:30:30.5`
`2017-01-01T03:30:30Z`

Example URL:
`https://api.goshippo.com/shipments/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30`

Note: Shipment objects older than 390 days are not returned. ## OpenAPI ````yaml /spec/shippoapi/public-api.yaml get /shipments openapi: 3.1.0 info: title: Shippo external API. version: '2018-02-08' x-logo: url: https://docs.goshippo.com/images/shippo-logo.svg contact: name: Shippo Developer Platform url: https://goshippo.com/contact/ description: Use this API to integrate with the Shippo service servers: - url: https://api.goshippo.com security: - APIKeyHeader: [] tags: - name: Overview description: >-

First-time users and those looking for specific integration tutorials, see our full API documentation and guides.
Download the API Specification yaml file

API Resources

All API URLs listed in this documentation are relative to https://api.goshippo.com/. For example, the `/addresses/` resource is reachable at `https://api.goshippo.com/addresses/`.

Authentication

The API requires Shippo's token HTTP Authentication with your Shippo token (live or test). In order to authenticate properly, please put `Authorization: ShippoToken ` in your header. You can find your token on the Shippo API settings page. For more information about authentication and test mode, please visit our Authentication guide. The API is available via Secure Socket Layer (SSL) only. All requests to the Shippo API must use TLS version 1.2 or higher.

Request & Response Data

Request data is passed to the API by POSTing JSON objects with the appropriate key/value-pairs to the respective resource. The documentation for each API resource contains more details on the values accepted by a given resource. Response data also formatted as JSON object. You can specify how many results per page are to be returned. For instance, `/rates/?results=25` will return up to 25 results.

REST & Disposable Objects

The Shippo API is built around REST principles. Use POST requests to create objects, GET requests to retrieve objects, and PUT requests to update objects. Only the Carrier Accounts object can be updated via PUT requests. All other objects such as Addresses, Parcels, Shipments, Rates, Transactions, Refunds, Customs Items, and Customs Declarations are disposable. This means that once you have created an object, you cannot change it. Instead, create a new one with the desired values.

API Version

This reference guide supports the Shippo API version: `2018-02-08` . To see reference guides for older API versions, see our legacy reference guide. For more information about Shippo API versions, see our API versions guide. - name: Addresses description: >- Addresses are the locations a parcel is being shipped **from** and **to**. They represent company and residential places. Among other things, you can use address objects to create shipments, calculate shipping rates, and purchase shipping labels. - name: Parcels description: >- A parcel is an item you are shipping. The parcel object includes details about its physical make-up of the parcel. It includes dimensions and weight that Shippo uses to calculate rates. - name: Shipments description: >- A shipment is the act of transporting goods. A shipment object contains **to** and **from** addresses, and the parcel details that you are shipping. You can use the shipment object to retrieve shipping rates and purchase a shipping label. - name: Rates description: >- A rate is the cost to ship a parcel from a carrier. The rate object details the service level including the cost and transit time. - name: Transactions x-displayName: Transactions (shipping labels) description: >- A transaction is the purchase of a shipping label from a shipping provider for a specific service. You can print purchased labels and used them to ship a parcel with a carrier, such as USPS or FedEx. - name: Customs Items description: >- Customs declarations are relevant information, including one or multiple customs items, you need to provide for customs clearance for your international shipments. - name: Customs Declarations description: >- Customs declarations are relevant information, including one or multiple customs items, you need to provide for customs clearance for your international shipments. - name: Refunds description: >- Refunds are reimbursements for successfully created but unused shipping labels or other charges. - name: Manifests description: >- A manifest is a single-page document with a barcode that carriers can scan to accept all packages into transit without the need to scan each item individually. They are close-outs of shipping labels of a certain day. Some carriers require manifests to process the shipments. - name: Carrier Accounts description: >- Carriers are the companies who deliver your package. Shippo uses Carrier account objects as credentials to retrieve shipping rates and purchase labels from shipping Carriers. - name: Webhooks description: >- Webhooks are a way for Shippo to notify your application when a specific event occurs. For example, when a label is purchased or when a shipment tracking status has changed. You can use webhooks to trigger actions in your application, such as sending an email or updating a database. - name: Tracking Status description: >-


If you purchased your shipping label through Shippo, you can also get all the tracking details of your Shipment from the Transaction object.

A tracking status of a package is an indication of current location of a package in the supply chain. For example, sorting, warehousing, or out for delivery. Use the tracking status object to track the location of your shipments. When using your Test token for tracking, you need to use Shippo's predefined tokens for testing different tracking statuses. You can find more information in our Tracking tutorial on how to do this, and what the payloads look like. - name: Batches description: >- A batch is a technique for creating multiple labels at once. Use the batch object to create and purchase many shipments in two API calls. After creating the batch, retrieve the batch to verify that all shipments are valid. You can add and remove shipments after you have created the batch. When all shipments are valid you can purchase the batch and retrieve all the shipping labels. - name: Orders x-displayName: Orders (beta) description: >- An order is a request from a customer to purchase goods from a merchant. Use the orders object to load orders from your system to the Shippo dashboard. You can use the orders object to create, retrieve, list, and manage orders programmatically. You can also retrieve shipping rates, purchase labels, and track shipments for each order. - name: Pickups description: >- A pickup is when you schedule a carrier to collect a package for delivery. Use Shippo’s pickups endpoint to schedule pickups with USPS and DHL Express for eligible shipments that you have already created. - name: Service Groups description: >- A service group is a set of service levels grouped together. Rates at checkout uses services groups to present available shipping options to customers in their shopping basket. - name: Carrier Parcel Templates description: >- A carrier parcel template represents a package used for shipping that has preset dimensions defined by a carrier. Some examples of a carrier parcel template include USPS Flat Rate Box and Fedex Small Pak. When using a carrier parcel template, the rates returned may be limited to the carrier that provides the box. You can create user parcel templates using a carrier parcel template. Shippo takes the dimensions of the carrier parcel template but you must configure the weight. - name: User Parcel Templates description: >- A user parcel template represents a package used for shipping that has preset dimensions and attributes defined by you. They are useful for capturing attributes of parcel-types you frequently use for shipping, allowing them to be defined once and then used for many shipments. These parcel templates can also be used for live rates. User parcel templates can also be created using a carrier parcel template, where the dimensions will be copied from the carrier presets, but the weight can be configured by you. - name: Rates at Checkout description: >- Rates at checkout is a tool for merchants to display up-to-date shipping estimates based on what's in their customers cart and where they’re shipping to. Merchants set up curated shipping options for customers in the checkout flow based on data in the shopping cart. The request must include the **to** address and item information. Optional fields are the **from** address and package information. If the optional fields are not included, the service will use the default address and/or package configured for rates at checkout. The response is a list of shipping options based on the Service Group configuration. (see Service Group configuration for details). # Default Parcel Template Assign one of your user parcel templates to be the default used when generating Live Rates. This template will be used by default when generating Live Rates, unless you explicitly provide a parcel in the Live Rates request. - name: Carriers description: > |Token | Carrier name| |:---|:---| | airterra | Airterra | | apc_postal | APC Postal| | apg | APG| | aramex | Aramex| | asendia_us | Asendia US| | australia_post | Australia Post (also used for Startrack)| | axlehire | Jitsu| | better_trucks | BetterTrucks| | borderguru | BorderGuru| | boxberry | Boxberry| | bring | Bring (also used for Posten Norge)| | canada_post | Canada Post| | chronopost | Chronopost| | collect_plus | CollectPlus| | correios_br | CorreiosBR| | correos_espana | Correos España | | colissimo | Colissimo| | deutsche_post | Deutsche Post| | dhl_benelux | DHL Benelux| | dhl_ecommerce | DHL eCommerce| | dhl_express | DHL Express| | dhl_germany_c2c | DHL Germany C2C| | dhl_germany | DHL Germany| | dpd_de | DPD GERMANY| | dpd_uk | DPD UK| | estafeta | Estafeta| | fastway_australia | Aramex| | fedex | FedEx| | globegistics | Globegistics (now Asendia)| | gls_us | GLS US| | gophr | Gophr| | gso | GSO| | hermes_germany_b2c | Hermes Germany B2C| | hermes_uk | Evri UK | | hongkong_post | Hongkong Post| | lasership | LaserShip| | lso | LSO| | mondial_relay | Mondial Relay| | new_zealand_post | New Zealand Post (also used for Pace and CourierPost)| | nippon_express | Nippon Express| | ontrac | OnTrac| | parcelforce | Parcelforce| | passport | Passport| | pcf | PCF| | poste_italiane | Poste Italiane | | posti | Posti| | purolator | Purolator| | royal_mail | Royal Mail| | royal_mail_sf | Royal Mail Storefeeder| | rr_donnelley | ePost Global| | russian_post | Russian Post| | skypostal | SkyPostal| | stuart | Stuart| | swyft | Swyft| | uds | UDS (United Delivery Service)| | ups | UPS| | usps | USPS| | veho | Veho | - name: Service Levels description: > Service levels represent the shipping service type for each carrier. Use the tokens below when creating shipments. ## USPS Service Levels |Token | Service name| |:---|:---| | usps_priority | Priority Mail| | usps_priority_express | Priority Mail Express| | usps_media_mail | Media Mail (grandfathered customers only)| | usps_priority_mail_international | Priority Mail International| | usps_priority_mail_express_international | Priority Mail Express International| | usps_first_class_package_international_service | First Class Package International| | usps_ground_advantage | Ground Advantage | ## FedEx Service Levels |Token | Service name| |:---|:---| | fedex_ground | FedEx Ground®| | fedex_home_delivery | FedEx Home Delivery®| | fedex_ground_economy | FedEx Ground® Economy| | fedex_2_day | FedEx 2Day®| | fedex_2_day_am | FedEx 2Day® A.M.| | fedex_express_saver | FedEx Express Saver®| | fedex_standard_overnight | FedEx Standard Overnight®| | fedex_priority_overnight | FedEx Priority Overnight®| | fedex_first_overnight | FedEx First Overnight®| | fedex_international_economy | FedEx International Economy®| | fedex_international_priority | FedEx International Priority®| | fedex_international_first | FedEx International First®| | fedex_international_connect_plus | FedEx International Connect Plus| ## UPS Service Levels |Token | Service name| |:---|:---| | ups_standard | UPS Standard| | ups_ground | UPS Ground| | ups_saver | UPS Saver| | ups_3_day_select | UPS 3 Day Select| | ups_second_day_air | UPS 2nd Day Air| | ups_second_day_air_am | UPS 2nd Day Air A.M.| | ups_next_day_air | UPS Next Day Air| | ups_next_day_air_saver | UPS Next Day Air Saver| | ups_next_day_air_early_am | UPS Next Day Air Early A.M.| | ups_express | UPS Express| | ups_express_plus | UPS Express Plus| | ups_expedited | UPS Expedited| ## Other Supported Carriers Additional service levels are available for: Airterra, APC Postal, APG, Asendia, Australia Post, Better Trucks, Canada Post, Chronopost, Colissimo, Correos España, DHL Express, DHL eCommerce, DHL Germany, DPD DE, DPD UK, Deutsche Post, Aramex Australia, Globegistics, GLS US, Jitsu, LaserShip, LSO, Mondial Relay, OnTrac, Parcelforce, Poste Italiane, ePost Global, Purolator, Royal Mail, Royal Mail Storefeeder, Swyft, UDS, Veho, and Evri UK. See the Schemas section for complete service level lists for each carrier. - name: Parcel Templates description: > A predefined package used by one or multiple carriers. When a template is given, the parcel dimensions do not have to be sent - the dimensions below will instead be used. The parcel weight is not affected by the use of a template. ## FedEx Parcel Templates |Token | Name | Dimensions| |:---|:---|:---| | FedEx_Box_10kg | FedEx® 10kg Box | 15.81 x 12.94 x 10.19 in| | FedEx_Box_25kg | FedEx® 25kg Box | 54.80 x 42.10 x 33.50 in| | FedEx_Box_Extra_Large_1 | FedEx® Extra Large Box (X1) | 11.88 x 11.00 x 10.75 in| | FedEx_Box_Extra_Large_2 | FedEx® Extra Large Box (X2) | 15.75 x 14.13 x 6.00 in| | FedEx_Box_Large_1 | FedEx® Large Box (L1) | 17.50 x 12.38 x 3.00 in| | FedEx_Box_Large_2 | FedEx® Large Box (L2) | 11.25 x 8.75 x 7.75 in| | FedEx_Box_Medium_1 | FedEx® Medium Box (M1) | 13.25 x 11.50 x 2.38 in| | FedEx_Box_Medium_2 | FedEx® Medium Box (M2) | 11.25 x 8.75 x 4.38 in| | FedEx_Box_Small_1 | FedEx® Small Box (S1) | 12.38 x 10.88 x 1.50 in| | FedEx_Box_Small_2 | FedEx® Small Box (S2) | 11.25 x 8.75 x 2.38 in| | FedEx_Envelope | FedEx® Envelope | 12.50 x 9.50 x 0.80 in| | FedEx_Padded_Pak | FedEx® Padded Pak | 11.75 x 14.75 x 2.00 in| | FedEx_Pak_1 | FedEx® Large Pak | 15.50 x 12.00 x 0.80 in| | FedEx_Pak_2 | FedEx® Small Pak | 12.75 x 10.25 x 0.80 in| | FedEx_Tube | FedEx® Tube | 38.00 x 6.00 x 6.00 in| | FedEx_XL_Pak | FedEx® Extra Large Pak | 17.50 x 20.75 x 2.00 in| ## UPS Parcel Templates |Token | Name | Dimensions| |:---|:---|:---| | UPS_Box_10kg | Box 10kg | 410.00 x 335.00 x 265.00 mm| | UPS_Box_25kg | Box 25kg | 484.00 x 433.00 x 350.00 mm| | UPS_Express_Box | Express Box | 460.00 x 315.00 x 95.00 mm| | UPS_Express_Box_Large | Express Box Large | 18.00 x 13.00 x 3.00 in| | UPS_Express_Box_Medium | Express Box Medium | 15.00 x 11.00 x 3.00 in| | UPS_Express_Box_Small | Express Box Small | 13.00 x 11.00 x 2.00 in| | UPS_Express_Envelope | Express Envelope | 12.50 x 9.50 x 2.00 in| | UPS_Express_Hard_Pak | Express Hard Pak | 14.75 x 11.50 x 2.00 in| | UPS_Express_Legal_Envelope | Express Legal Envelope | 15.00 x 9.50 x 2.00 in| | UPS_Express_Pak | Express Pak | 16.00 x 12.75 x 2.00 in| | UPS_Express_Tube | Express Tube | 970.00 x 190.00 x 165.00 mm| | UPS_Laboratory_Pak | Laboratory Pak | 17.25 x 12.75 x 2.00 in| | UPS_Pad_Pak | Pad Pak | 14.75 x 11.00 x 2.00 in| ## USPS Parcel Templates |Token | Name | Dimensions| |:---|:---|:---| | USPS_FlatRateCardboardEnvelope | Flat Rate Cardboard Envelope | 12.50 x 9.50 x 0.75 in| | USPS_FlatRateEnvelope | Flat Rate Envelope | 12.50 x 9.50 x 0.75 in| | USPS_FlatRateGiftCardEnvelope | Flat Rate Gift Card Envelope | 10.00 x 7.00 x 0.75 in| | USPS_FlatRateLegalEnvelope | Flat Rate Legal Envelope | 15.00 x 9.50 x 0.75 in| | USPS_FlatRatePaddedEnvelope | Flat Rate Padded Envelope | 12.50 x 9.50 x 1.00 in| | USPS_FlatRateWindowEnvelope | Flat Rate Window Envelope | 10.00 x 5.00 x 0.75 in| | USPS_LargeFlatRateBoardGameBox | Large Flat Rate Board Game Box | 24.06 x 11.88 x 3.13 in| | USPS_LargeFlatRateBox | Large Flat Rate Box | 12.25 x 12.25 x 6.00 in| | USPS_APOFlatRateBox | APO/FPO/DPO Large Flat Rate Box | 12.25 x 12.25 x 6.00 in| | USPS_MediumFlatRateBox1 | Medium Flat Rate Box 1 | 11.25 x 8.75 x 6.00 in| | USPS_MediumFlatRateBox2 | Medium Flat Rate Box 2 | 14.00 x 12.00 x 3.50 in| | USPS_RegionalRateBoxA1 | Regional Rate Box A1 | 10.13 x 7.13 x 5.00 in| | USPS_RegionalRateBoxA2 | Regional Rate Box A2 | 13.06 x 11.06 x 2.50 in| | USPS_RegionalRateBoxB1 | Regional Rate Box B1 | 12.25 x 10.50 x 5.50 in| | USPS_RegionalRateBoxB2 | Regional Rate Box B2 | 16.25 x 14.50 x 3.00 in| | USPS_SmallFlatRateBox | Small Flat Rate Box | 8.69 x 5.44 x 1.75 in| | USPS_SmallFlatRateEnvelope | Small Flat Rate Envelope | 10.00 x 6.00 x 4.00 in| ## Other Carriers Additional parcel templates are available for DHL eCommerce, DPD UK, and Aramex Australia. See the Schemas section for complete template lists. - name: Shippo Accounts description: >- Shippo Accounts are used by Shippo Platform Accounts to create and manage Managed Shippo Accounts. Managed Shippo Accounts are headless accounts that represent your customers. They are opaque to your end customers, meaning customers do not need to create their own Shippo login or have a billing relationship with Shippo. They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. See our guide for more details. - name: Customs Declaration B13A Filing Option description: > B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). More information on reporting commercial exports from Canada. **Allowed values:** - `FILED_ELECTRONICALLY` - `SUMMARY_REPORTING` - `NOT_REQUIRED` - name: Customs Declaration Contents Type description: | Type of goods of the shipment. **Allowed values:** - `DOCUMENTS` - `GIFT` - `SAMPLE` - `MERCHANDISE` - `HUMANITARIAN_DONATION` - `RETURN_MERCHANDISE` - `OTHER` - name: Customs Declaration EEL/PFC description: > EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most other shipments from the US, `NOEEI_30_37_a` is applicable. **Allowed values:** - `NOEEI_30_37_a` - `NOEEI_30_37_h` - `NOEEI_30_37_f` - `NOEEI_30_36` - `AES_ITN` - name: Customs Declaration Incoterm description: > The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. eDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK. If expecting DAP for other carriers, please use DDU. **Allowed values:** - `DDP` - `DDU` - `FCA` - `DAP` - `eDAP` - name: Customs Declaration Non Delivery Option description: > Indicates how the carrier should proceed in case the shipment can't be delivered. **Allowed values:** - `ABANDON` - `RETURN` - name: Address Validation Source description: | Source of the address validation message. **Allowed values:** - `Shippo Address Validator` - `UPS` - name: Address Validation Codes description: | Validation result codes returned by the address validation service. **Allowed values:** - `verification_error` - `unknown_street` - `component_mismatch_error` - `multiple_match` - `sub_premise_number_invalid` - `sub_premise_number_missing` - `premise_number_invalid` - `premise_number_missing` - `box_number_invalid` - `box_number_missing` - `pmb_number_missing` - `postal_code_change` - `administrative_area_change` - `locality_change` - `dependent_locality_change` - `street_name_change` - `street_type_change` - `street_directional_change` - `sub_premise_type_change` - `sub_premise_number_change` - `double_dependent_locality_change` - `subadministrative_area_change` - `subnational_area_change` - `po_box_change` - `premise_type_change` - `house_number_change` - `organization_change` - `extraneous_information` - `usps_door_inaccessible` - `administrative_area_partial` - `city_partial` - `street_partial` - `building_partial` - `subpremise_partial` - `administrative_area_full` - `city_full` - `thoroughfare_full` - `premises_full` - `subpremise_full` - `geocoded_street` - `geocoded_neighborhood` - `geocoded_community` - `geocoded_state` - `geocoded_rooftop` - `geocoded_interpolated_rooftop` - `invalid_postal_code` - `postal_code_not_found` - `empty_request` - `service_error` - `street_detail_missing` - `Invalid City/State/Zip` - `Default Match` - `Unknown Street` - `Address Not Found` - `Non-Deliverable ZIP4` - `Multiple Responses` - `Invalid Dual Address` - `Invalid State` - `Invalid City` - `Ambiguous Address` paths: /shipments: get: tags: - Shipments summary: List all shipments description: >- Returns a list of all shipment objects.

In order to filter results, you must use the below path parameters. Provided dates should be ISO 8601 UTC dates (timezone offsets are currently not supported).

Optional path parameters:
`object_created_gt`- object(s) created greater than a provided date time
`object_created_gte` - object(s) created greater than or equal to a provided date time
`object_created_lt` - object(s) created less than a provided date time
`object_created_lte` - object(s) created less than or equal to a provided date time
Date format examples:
`2017-01-01`
`2017-01-01T03:30:30` or `2017-01-01T03:30:30.5`
`2017-01-01T03:30:30Z`

Example URL:
`https://api.goshippo.com/shipments/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30`

Note: Shipment objects older than 390 days are not returned. operationId: ListShipments parameters: - $ref: '#/components/parameters/PageTokenQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/ResultsPerPageQueryParam' - $ref: '#/components/parameters/ObjectCreatedGtQueryParam' - $ref: '#/components/parameters/ObjectCreatedGteQueryParam' - $ref: '#/components/parameters/ObjectCreatedLtQueryParam' - $ref: '#/components/parameters/ObjectCreatedLteQueryParam' - $ref: '#/components/parameters/ShippoApiVersionHeader' responses: '200': $ref: '#/components/responses/shipmentPaginatedResponse' '400': $ref: '#/components/responses/badRequestResponse' x-codeSamples: - label: cURL lang: cURL source: |- curl https://api.goshippo.com/shipments/ \ -H "Authorization: ShippoToken " - lang: python label: Python source: |- import shippo from shippo.models import operations s = shippo.Shippo( api_key_header='ShippoToken ', shippo_api_version='2018-02-08', ) res = s.shipments.list(request=operations.ListShipmentsRequest()) if res is not None: # handle response pass - lang: typescript label: Typescript source: |- import { Shippo } from "shippo"; const shippo = new Shippo({ apiKeyHeader: "ShippoToken ", shippoApiVersion: "2018-02-08", }); async function run() { const result = await shippo.shipments.list({}); // Handle the result console.log(result); } run(); - lang: php label: PHP source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Shippo\API; use Shippo\API\Models\Operations; $sdk = API\Shippo::builder() ->setSecurity( 'ShippoToken ' ) ->setShippoApiVersion('2018-02-08') ->build(); $request = new Operations\ListShipmentsRequest(); $response = $sdk->shipments->list( request: $request ); if ($response->shipmentPaginatedList !== null) { // handle response } - lang: csharp label: C# source: |- using Shippo; using Shippo.Models.Components; using Shippo.Models.Requests; var sdk = new ShippoSDK( apiKeyHeader: "ShippoToken ", shippoApiVersion: "2018-02-08" ); ListShipmentsRequest req = new ListShipmentsRequest() {}; var res = await sdk.Shipments.ListAsync(req); // handle response - lang: java label: Java source: >- package hello.world; import com.goshippo.shippo_sdk.Shippo; import com.goshippo.shippo_sdk.models.operations.ListShipmentsRequest; import com.goshippo.shippo_sdk.models.operations.ListShipmentsResponse; import java.lang.Exception; public class Application { public static void main(String[] args) throws Exception { Shippo sdk = Shippo.builder() .apiKeyHeader("ShippoToken ") .shippoApiVersion("2018-02-08") .build(); ListShipmentsRequest req = ListShipmentsRequest.builder() .build(); ListShipmentsResponse res = sdk.shipments().list() .request(req) .call(); if (res.shipmentPaginatedList().isPresent()) { // handle response } } } components: parameters: PageTokenQueryParam: description: The page token for paginated results in: query name: page_token required: false schema: type: string PageNumberQueryParam: description: The page number you want to select in: query name: page schema: type: integer format: int64 default: 1 ResultsPerPageQueryParam: description: The number of results to return per page (max 100) in: query name: results schema: type: integer format: int64 maximum: 100 default: 25 ObjectCreatedGtQueryParam: description: Object(s) created greater than a provided date and time. in: query name: object_created_gt required: false schema: type: string ObjectCreatedGteQueryParam: description: Object(s) created greater than or equal to a provided date and time. in: query name: object_created_gte required: false schema: type: string ObjectCreatedLtQueryParam: description: Object(s) created lesser than a provided date and time. in: query name: object_created_lt required: false schema: type: string ObjectCreatedLteQueryParam: description: Object(s) created lesser than or equal to a provided date and time. in: query name: object_created_lte required: false schema: type: string ShippoApiVersionHeader: description: >- Optional string used to pick a non-default API version to use. See our API version guide. in: header name: SHIPPO-API-VERSION schema: type: string example: '2018-02-08' default: '2018-02-08' x-default: '2018-02-08' x-speakeasy-globals-hidden: true responses: shipmentPaginatedResponse: description: Paginated list of shipments content: application/json: schema: $ref: '#/components/schemas/ShipmentPaginatedList' badRequestResponse: description: Bad request content: application/json: schema: $ref: '#/components/schemas/BadRequest' schemas: ShipmentPaginatedList: allOf: - $ref: '#/components/schemas/PaginatedList' - properties: results: items: $ref: '#/components/schemas/Shipment' type: array BadRequest: additionalProperties: true type: object PaginatedList: properties: next: example: baseurl?page=3&results=10 type: string previous: example: baseurl?page=1&results=10 type: string type: object Shipment: x-tags: - Shipments allOf: - $ref: '#/components/schemas/ShipmentBase' - description: Shipment represents the parcel as retrieved from the database properties: address_from: $ref: '#/components/schemas/AddressFrom' address_return: $ref: '#/components/schemas/AddressReturn' address_to: $ref: '#/components/schemas/AddressTo' carrier_accounts: items: type: string type: array description: >- An array of object_ids of the carrier account objects to be used for getting shipping rates for this shipment. If no carrier account object_ids are set in this field, Shippo will attempt to generate rates using all the carrier accounts that have the `active` field set. customs_declaration: $ref: '#/components/schemas/CustomsDeclaration' messages: $ref: '#/components/schemas/ResponseMessageList' object_created: format: date-time type: string description: Date and time of Shipment creation. object_id: example: adcfdddf8ec64b84ad22772bce3ea37a type: string description: Unique identifier of the given Shipment object. object_owner: example: pp@gmail.com type: string description: Username of the user who created the Shipment object. object_updated: format: date-time type: string description: Date and time of last Shipment update. parcels: items: $ref: '#/components/schemas/Parcel' type: array description: List of Parcel objects to be shipped. rates: items: $ref: '#/components/schemas/Rate' type: array description: >- An array with all available rates. If async has been set to false in the request, this will be populated with all available rates in the response. Otherwise rates will be created asynchronously and this array will initially be empty. status: enum: - ERROR - QUEUED - SUCCESS - WAITING example: QUEUED type: string description: >- `Waiting` shipments have been successfully submitted but not yet been processed. `Queued` shipments are currently being processed. `Success` shipments have been processed successfully, meaning that rate generation has concluded. `Error` does not occur currently and is reserved for future use. test: type: boolean description: Indicates whether the object has been created in test mode. required: - address_to - address_from - parcels - object_created - object_updated - object_id - object_owner - status - rates - carrier_accounts - messages - metadata ShipmentBase: properties: extra: $ref: '#/components/schemas/ShipmentExtra' metadata: example: Customer ID 123456 type: string maxLength: 100 description: >- A string of up to 100 characters that can be filled with any additional information you want to attach to the object. shipment_date: example: '2021-03-22T12:00:00Z' type: string description: >- Date the shipment will be tendered to the carrier. Must be in the format `2014-01-18T00:35:03.463Z`. Defaults to current date and time if no value is provided. Please note that some carriers require this value to be in the future, on a working day, or similar. type: object AddressFrom: allOf: - $ref: '#/components/schemas/Address' description: >- Address object of the sender / seller. Will be returned expanded by default. AddressReturn: allOf: - $ref: '#/components/schemas/Address' description: >- ID of the Address object where the shipment will be sent back to if it is not delivered (Only available for UPS, USPS, and Fedex shipments).
If this field is not set, your shipments will be returned to the address_from. AddressTo: allOf: - $ref: '#/components/schemas/Address' description: >- Address object of the recipient / buyer. Will be returned expanded by default. CustomsDeclaration: title: Customs Declaration x-tags: - Customs Declarations allOf: - $ref: '#/components/schemas/CustomsDeclarationBase' - properties: address_importer: type: string example: 257ba08436604d2aaf069caafe7acb2a description: Object ID of the Importer address. b13a_filing_option: $ref: '#/components/schemas/CustomsDeclarationB13AFilingOption' contents_type: $ref: '#/components/schemas/CustomsDeclarationContentsType' eel_pfc: $ref: '#/components/schemas/CustomsDeclarationEelPfc' incoterm: $ref: '#/components/schemas/CustomsDeclarationIncoterm' invoiced_charges: $ref: '#/components/schemas/CustomsInvoicedCharges' items: example: - 5087f181d1dc4b14b73fdbf636498886 items: type: string type: array description: Distinct Parcel content items as Customs Items object_ids. non_delivery_option: $ref: '#/components/schemas/CustomsDeclarationNonDeliveryOption' object_created: example: '2014-07-17T01:01:08.306Z' format: date-time type: string description: Date and time of object creation. object_id: example: e2197a54da9d470480f4f8796cc419cb type: string description: Unique identifier of the given object. object_owner: example: shippotle@shippo.com type: string description: Username of the user who created the object. object_state: $ref: '#/components/schemas/ObjectStateEnum' object_updated: example: '2014-07-17T01:01:08.306Z' format: date-time type: string description: Date and time of last object update. test: example: true type: boolean description: Indicates whether the object has been created in test mode. required: - items ResponseMessageList: items: $ref: '#/components/schemas/ResponseMessage' type: array Parcel: x-tags: - Parcels allOf: - $ref: '#/components/schemas/ParcelBase' - $ref: '#/components/schemas/ParcelDimensions' - properties: object_created: description: Date and time of Parcel creation. example: '2014-07-09T02:19:13.174Z' format: date-time type: string object_id: description: >- Unique identifier of the given Parcel object. This ID is required to create a Shipment object. example: adcfdddf8ec64b84ad22772bce3ea37a type: string object_owner: description: Username of the user who created the Parcel object. example: shippotle@shippo.com type: string object_state: description: >- A Parcel will only be valid when all required values have been sent and validated successfully. example: VALID enum: - VALID type: string object_updated: description: >- Date and time of last Parcel update. Since you cannot update Parcels after they were created, this time stamp reflects the time when the Parcel was changed by Shippo's systems for the last time, e.g., during sorting the dimensions given. example: '2014-07-09T02:19:13.174Z' format: date-time type: string template: $ref: '#/components/schemas/ParcelTemplateEnumSet' test: type: boolean description: Indicates whether the object has been created in test mode. required: - length - width - height - distance_unit - weight - mass_unit type: object Rate: x-tags: - Rates allOf: - $ref: '#/components/schemas/RateAmountAndCurrency' - properties: arrives_by: type: string example: '08:30:00' description: >- Predicted time the carrier will deliver the package in the destination's local time zone. In the format `HH:MM:SS`. attributes: items: enum: - BESTVALUE - CHEAPEST - FASTEST type: string type: array description: >- An array containing specific attributes of this Rate in context of the entire shipment. Attributes can be assigned `CHEAPEST`, `FASTEST`, or `BESTVALUE`. carrier_account: example: 078870331023437cb917f5187429b093 type: string description: >- Object ID of the carrier account that has been used to retrieve the rate. duration_terms: example: Delivery in 1 to 3 business days type: string description: >- Further clarification of the transit times. Often, this includes notes that the transit time as given in "days" is only an average, not a guaranteed time. estimated_days: example: 2 format: int64 type: integer description: >- Estimated transit time (duration) in days of the Parcel at the given servicelevel. Please note that this is not binding, but only an average value as given by the provider. Shippo is not able to guarantee any transit times. included_insurance_price: example: '1.05' type: string description: >- Cost to the user to insure the Rate for the requested amount of coverage, if insurance coverage was requested. Expressed in the currency used in the sender's country. Will be null if no insurance coverage was requested, or if insurance is requested from a non-standard insurance provider. Please note this price is already included in the `amount` and `amount_local` fields on the Rate. Do not add this field to them. messages: $ref: '#/components/schemas/ResponseMessageList' object_created: format: date-time type: string description: Date and time of Rate creation. object_id: example: adcfdddf8ec64b84ad22772bce3ea37a type: string description: Unique identifier of the given Rate object. object_owner: example: pp@gmail.com type: string description: Username of the user who created the rate object. provider: example: USPS type: string description: Carrier offering the rate, e.g., `FedEx` or `Deutsche Post DHL`. provider_image_75: example: https://cdn2.goshippo.com/providers/75/USPS.png type: string description: >- URL to the provider logo with max. dimensions of 75*75px. Please refer to the provider's Logo Usage Guidelines before using the logo. provider_image_200: example: https://cdn2.goshippo.com/providers/200/USPS.png type: string description: >- URL to the provider logo with max. dimensions of 200*200px. Please refer to the provider's Logo Usage Guidelines before using the logo. servicelevel: $ref: '#/components/schemas/ServiceLevelWithParent' shipment: example: adcfdddf8ec64b84ad22772bce3ea37a type: string test: type: boolean description: Indicates whether the object has been created in test mode. zone: type: string example: '1' description: >- The parcel's transit zone token. These tokens can vary depending on the provider. required: - object_created - object_id - object_owner - shipment - attributes - amount - currency - amount_local - currency_local - provider - servicelevel - carrier_account type: object ShipmentExtra: title: Shipment Extra x-tags: - Shipments description: An object holding optional extra services to be requested. properties: accounts_receivable_customer_account: $ref: '#/components/schemas/UPSReferenceFields' description: >- UPS only. Adds custom accounts receivable customer account reference to UPS labels. alcohol: $ref: '#/components/schemas/Alcohol' ancillary_endorsement: enum: - FORWARDING_SERVICE_REQUESTED - RETURN_SERVICE_REQUESTED description: >- Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only). appropriation_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom appropriation number reference to UPS labels. authority_to_leave: type: boolean description: >- Request `true` to give carrier permission to leave the parcel in a safe place if no one answers the door (where supported). When set to `false`, if no one is available to receive the item, the parcel will not be left (*surcharges may be applicable). bill_of_lading_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom bill of lading number reference to UPS labels. billing: $ref: '#/components/schemas/Billing' bypass_address_validation: type: boolean description: Bypasses address validation (USPS, UPS, & LaserShip only). carbon_neutral: type: boolean description: Request carbon offsets by passing true (UPS only). carrier_hub_id: type: string description: Identifies the carrier injection site. carrier_hub_travel_time: type: integer description: >- Travel time in hours from fulfillment center to carrier injection site. COD: $ref: '#/components/schemas/COD' cod_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom COD number reference to UPS labels. container_type: type: string description: Specify container type. critical_pull_time: type: string description: >- Carrier arrival time to pickup packages from the fulfillment center. UTC format: `%Y-%m-%dT%H:%M:%SZ` customer_branch: type: string description: Specify customer branch (Lasership only). customer_reference: $ref: '#/components/schemas/CustomerReference' dangerous_goods: $ref: '#/components/schemas/DangerousGoodsObject' dangerous_goods_code: enum: - '01' - '02' - '03' - '04' - '05' - '06' - '07' - '08' - '09' description: >- Dangerous Goods Code (DHL eCommerce only). See Category Codes dealer_order_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom dealer order number reference to UPS labels. delivery_instructions: type: string description: >- Specify delivery instructions. Up to 500 characters. (FedEx and OnTrac only). dept_number: $ref: '#/components/schemas/DepartmentNumber' dry_ice: $ref: '#/components/schemas/DryIce' fda_product_code: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom FDA product code reference to UPS labels. fulfillment_center: type: string description: The fulfilment center where the package originates from. insurance: $ref: '#/components/schemas/Insurance' invoice_number: $ref: '#/components/schemas/InvoiceNumber' is_return: type: boolean description: >- This field specifies if it is a scan-based return shipment. See the Create a return shipment section for more details. lasership_attrs: description: >- Specify Lasership Attributes (Lasership only). Multiple options accepted. items: $ref: '#/components/schemas/ShipmentExtraLasershipAttributesEnum' type: array lasership_declared_value: type: string description: Declared value (Lasership only). Defaults to `50.00`. manifest_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom manifest number reference to UPS labels. model_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom model number reference to UPS labels. part_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom part number reference to UPS labels. po_number: $ref: '#/components/schemas/PoNumber' preferred_delivery_timeframe: enum: - '10001200' - '12001400' - '14001600' - '16001800' - '18002000' - '19002100' description: >- Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is `HHMMHHMM` premium: type: boolean description: >- Add premium service to a shipment (DHL Germany international shipments only). production_code: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom product code reference to UPS labels. purchase_request_number: $ref: '#/components/schemas/UPSReferenceFields' description: >- UPS only. Adds custom purchase request number reference to UPS labels. qr_code_requested: type: boolean description: >- Request a QR code for a given transaction when creating a shipping label (USPS domestic and Evri UK only). reference_1: type: string maxLength: 50 description: >- Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 40 characters (Express services); Max 30 characters (Ground services) | reference_2: type: string maxLength: 50 description: >- Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. For DHL eCommerce, this field can be used for billing reference. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 30 characters | request_retail_rates: type: boolean description: >- Returns retail rates instead of account-based rates (UPS and FedEx only). return_service_type: type: string description: >- Request additional return option for return shipments (UPS and Lasership only). oneOf: - $ref: '#/components/schemas/ShipmentExtraReturnServiceTypeUPSEnum' - $ref: '#/components/schemas/ShipmentExtraReturnServiceTypeLasershipEnum' rma_number: $ref: '#/components/schemas/RmaNumber' saturday_delivery: type: boolean description: Marks shipment as to be delivered on a Saturday. salesperson_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom salesperson number reference to UPS labels. serial_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom serial number reference to UPS labels. signature_confirmation: enum: - STANDARD - ADULT - CERTIFIED - INDIRECT - CARRIER_CONFIRMATION description: >- Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) or Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only). store_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom store number reference to UPS labels. transaction_reference_number: $ref: '#/components/schemas/UPSReferenceFields' description: UPS only. Adds custom transaction reference number to UPS labels. usmca_eligible: type: boolean description: >- UPS only. Request USMCA (United States-Mexico-Canada Agreement) preferential tariff treatment. When enabled, it includes the USMCA eligibility declaration in customs documentation. Supported routes and value limits: - USA/Canada → Mexico: ≤ $1,000 USD - Canada/Mexico → USA: ≤ $2,500 USD - USA/Mexico → Canada: ≤ $3,300 CAD Only for declaration-only shipments, full USMCA - FormType 04 (Certificate of Origin) is not supported. type: object Address: x-tags: - Addresses allOf: - $ref: '#/components/schemas/AddressBase' - properties: is_complete: example: true type: boolean description: >- Complete addresses contain all required values.

Incomplete addresses have failed one or multiple validations.
Incomplete Addresses are eligible for requesting rates but lack at least one required value for purchasing labels. latitude: description: Latitude of address type: - number - string longitude: description: Longitude of address type: - number - string object_created: example: '2014-07-09T02:19:13.174Z' format: date-time type: string description: Date and time of Address creation. object_id: example: d799c2679e644279b59fe661ac8fa488 type: string description: |- Unique identifier of the given Address object. This ID is required to create a Shipment object. object_owner: example: shippotle@shippo.com type: string description: Username of the user who created the Address object. object_updated: example: '2014-07-09T02:19:13.174Z' format: date-time type: string description: >- Date and time of last Address update. Since you cannot update Addresses after they were created, this time stamp reflects the time when the Address was changed by Shippo's systems for the last time, e.g., during the approximation of one or more values. validation_results: $ref: '#/components/schemas/AddressValidationResults' test: type: boolean example: false description: Indicates whether the object has been created in test mode. required: - country CustomsDeclarationBase: properties: aes_itn: description: |- **required if eel_pfc is `AES_ITN`**
AES / ITN reference of the shipment. type: string b13a_filing_option: type: string b13a_number: description: >- **must be provided if and only if b13a_filing_option is provided**
Represents:
the Proof of Report (POR) Number when b13a_filing_option is `FILED_ELECTRONICALLY`;
the Summary ID Number when b13a_filing_option is `SUMMARY_REPORTING`;
or the Exemption Number when b13a_filing_option is `NOT_REQUIRED`. type: string certificate: type: string description: Certificate reference of the shipment. certify: example: true type: boolean description: >- Expresses that the certify_signer has provided all information of this customs declaration truthfully. certify_signer: example: Shawn Ippotle type: string description: >- Name of the person who created the customs declaration and is responsible for the validity of all information provided. commercial_invoice: type: boolean contents_explanation: description: |- **required if contents_type is `OTHER`**
Explanation of the type of goods of the shipment. example: T-Shirt purchase type: string disclaimer: type: string maxLength: 1000 description: >- Disclaimer for the shipment and customs information that have been provided. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 554 characters | duties_payor: description: >- Specifies who will pay the duties for the shipment. Only accepted for FedEx shipments. type: object properties: account: type: string description: Account number to be billed for duties. example: '2323434543' type: enum: - SENDER - RECIPIENT - THIRD_PARTY description: Party to be billed for duties. example: THIRD_PARTY address: type: object properties: name: type: string description: Name of the party to be billed for duties. example: Patrick Kavanagh zip: type: string description: Postal code of the party to be billed for duties. example: '80331' country: type: string description: Country ISO code of account number to be billed. example: DE exporter_identification: $ref: '#/components/schemas/CustomsExporterIdentification' exporter_reference: type: string description: Exporter reference of an export shipment. importer_reference: type: string description: Importer reference of an import shipment. is_vat_collected: type: boolean description: >- Indicates whether the shipment's destination VAT has been collected. May be required for some destinations. invoice: example: '#123123' type: string maxLength: 15 description: Invoice reference of the shipment. license: type: string description: License reference of the shipment. metadata: example: 'Order ID #123123' type: string description: >- A string of up to 100 characters that can be filled with any additional information you want to attach to the object. notes: type: string description: Additional notes to be included in the customs declaration. required: - certify_signer - certify - non_delivery_option - contents_type type: object CustomsDeclarationB13AFilingOption: type: string example: FILED_ELECTRONICALLY description: >- B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). More information on reporting commercial exports from Canada. Allowed values available here CustomsDeclarationContentsType: type: string description: >- Type of goods of the shipment. Allowed values available here example: MERCHANDISE CustomsDeclarationEelPfc: type: string description: >- EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most other shipments from the US, `NOEEI_30_37_a` is applicable. Allowed values available here example: NOEEI_30_37_a CustomsDeclarationIncoterm: type: string description: >- The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. eDAP is available for DPD UK only. DAP is available for DHL Express, FedEx, and DPD UK. If expecting DAP for other carriers, please use DDU. Allowed values available here Carrier-specific restrictions are in the table below. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Must be one of DDP, DDU, FCA, DAP | example: DDP CustomsInvoicedCharges: description: >- Additional invoiced charges to be shown on the Customs Declaration Commercial Invoice. properties: currency: type: string format: iso-4217 description: >- Currency for the invoiced charges amounts incurred on the end consumer. total_shipping: type: string description: Total shipping 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. other_fees: type: string description: Other fees paid by the buyer. required: - currency type: object CustomsDeclarationNonDeliveryOption: type: string description: >- Indicates how the carrier should proceed in case the shipment can't be delivered. Allowed values available here example: RETURN ObjectStateEnum: type: string enum: - VALID - INVALID description: Indicates the validity of the enclosing object ResponseMessage: description: >- Message returned with supporting information from a request. In some cases this can be an error message, for example a timeout from a carrier. If available, the origin of the message is displayed in `source`. properties: source: description: Origin of message example: UPS type: string code: description: Classification of message example: carrier_timeout type: string text: description: Message content example: UPS API did not respond. Please try again in a few minutes. type: string type: object ParcelBase: properties: extra: $ref: '#/components/schemas/ParcelExtra' metadata: type: string example: Customer ID 123456 mass_unit: $ref: '#/components/schemas/WeightUnitEnum' weight: description: >- Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. example: '1' type: string type: object ParcelDimensions: properties: distance_unit: $ref: '#/components/schemas/DistanceUnitEnum' description: The measure unit used for length, width and height. height: description: >- Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. example: '1' type: string length: description: >- Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. example: '1' type: string width: description: >- Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. example: '1' type: string type: object ParcelTemplateEnumSet: description: >- If template is passed, `length`, `width`, `height`, and `distance_unit` are not required oneOf: - $ref: '#/components/schemas/ParcelTemplateFedExEnum' - $ref: '#/components/schemas/ParcelTemplateUPSEnum' - $ref: '#/components/schemas/ParcelTemplateUSPSEnum' - $ref: '#/components/schemas/ParcelTemplateDHLeCommerceEnum' - $ref: '#/components/schemas/ParcelTemplateDPDUKEnum' - $ref: '#/components/schemas/ParcelTemplateAramexAustraliaEnum' x-speakeasy-include: true RateAmountAndCurrency: properties: amount: example: '5.5' type: string description: >- Final Rate price, expressed in the currency used in the sender's country. amount_local: example: '5.5' type: string description: >- Final Rate price, expressed in the currency used in the recipient's country. currency: example: USD type: string description: >- Currency used in the sender's country, refers to `amount`. The official ISO 4217 currency codes are used, e.g. `USD` or `EUR`. currency_local: example: USD type: string description: >- Currency used in the recipient's country, refers to `amount_local`. The official ISO 4217 currency codes are used, e.g. `USD` or "EUR". ServiceLevelWithParent: allOf: - $ref: '#/components/schemas/ServiceLevel' - properties: parent_servicelevel: allOf: - $ref: '#/components/schemas/ServiceLevel' - description: >- Used for some Service Levels to link to the more "generic" version of this Service Level - for example, if this Service Level is a variation specific to shipments to Europe("ups_saver_eu"), the "parent" is the fully generic version ("ups_saver"). Helpful when displaying Service Levels to users. Has the same structure of the servicelevel - "name", "token", "terms", and "extended_token", or it is otherwise null. UPSReferenceFields: properties: prefix: type: string description: Custom prefix text. example: ABC value: type: string description: Label reference text. 35 character limit. example: value ref_sort: type: integer description: >- Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers. example: 1 Alcohol: description: Indicates that a shipment contains Alcohol (Fedex and UPS only). properties: contains_alcohol: type: boolean description: >- Mandatory for Fedex and UPS. Specifies that the package contains Alcohol. recipient_type: enum: - licensee - consumer description: >- Mandatory for Fedex only. License type of the recipient of the Alcohol Package. type: object Billing: description: Specify billing details (UPS, FedEx, and DHL Germany only). properties: account: type: string description: >- Account number to be billed. (For DHL Germany, leave this field blank.) country: type: string format: iso-3166 description: >- Country iso2 code of account number to be billed (required for UPS third party billing only). participation_code: type: string description: >- 2 digit code used to override your default participation code associated with your DHL Germany account. type: enum: - SENDER - RECIPIENT - THIRD_PARTY - THIRD_PARTY_CONSIGNEE - COLLECT description: Party to be billed. (Leave blank for DHL Germany.) zip: type: string description: >- ZIP code of account number to be billed (required for UPS if there is a zip on the billing account). type: object COD: description: Specify collection on delivery details (UPS only). properties: amount: description: Amount to be collected. example: '5.5' type: string currency: description: >- Currency for the amount to be collected. Currently only USD is supported for UPS. example: USD type: string payment_method: description: >- Secured funds include money orders, certified cheques and others (see UPS for details). If no payment_method inputted the value defaults to "ANY".) enum: - SECURED_FUNDS - CASH - ANY example: CASH type: string title: COD Specify collection on delivery details (UPS only). type: object CustomerReference: description: Specify the reference field on the label (FedEx and UPS only). properties: prefix: type: string description: >- Custom prefix for customer reference field (ZPL labels only). Up to 11 characters, including trailing spaces. Empty string indicates removal of default prefix. To use the default prefix, do not include this property. value: type: string maxLength: 40 description: >- Optional text to be printed on the shipping label for customer reference. Up to 40 characters. If this is provided, reference_1 will be ignored. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 40 characters (Express services); Max 30 characters (Ground services) | ref_sort: type: integer description: >- Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers. example: 1 type: object DangerousGoodsObject: description: >- Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents are provided, only certain USPS service levels will be eligible. For more information, see our guide on hazardous or dangerous materials shipping. properties: contains: type: boolean description: Indicates if the shipment contains dangerous goods. biological_material: $ref: '#/components/schemas/DangerousGoodsBiologicalMaterial' lithium_batteries: $ref: '#/components/schemas/DangerousGoodsLithiumBatteries' type: object DepartmentNumber: description: Specify the department number field on the label (FedEx and UPS only). properties: prefix: type: string description: >- Custom prefix for department number field (ZPL labels only). Up to 11 characters, including trailing spaces. Empty string indicates removal of default prefix. To use the default prefix, do not include this property. value: type: string maxLength: 40 description: >- Optional text to be printed on the shipping label for department number. Up to 40 characters. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 30 characters | ref_sort: type: integer description: >- Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers. example: 3 type: object DryIce: description: Specify that the package contains Dry Ice (FedEx, Veho, and UPS only). properties: contains_dry_ice: type: boolean description: Mandatory. Specifies that the package contains Dry Ice. weight: type: string description: >- Mandatory. Units must be in Kilograms. Cannot be greater than package weight. type: object Insurance: description: >- To add 3rd party insurance powered by XCover, specify
`amount`, `content`, and `currency`.
Alternatively, you can choose carrier provided insurance by additionally specifying `provider` (UPS, FedEx and OnTrac only).

If you do not want to add insurance to your shipment, do not set these parameters. properties: amount: description: Declared value of the goods you want to insure. example: '5.5' type: string content: type: string description: Description of package content. currency: example: USD type: string format: iso-4217 description: |- Currency for the amount value. Currently only USD is supported for FedEx and UPS. provider: enum: - FEDEX - UPS - ONTRAC description: >- To have insurance cover provided by a carrier directly instead of Shippo's provider (XCover), set `provider` to `FEDEX`, `UPS`, or `ONTRAC`. type: object InvoiceNumber: description: Specify the invoice number field on the label (FedEx and UPS only). properties: prefix: type: string description: >- Custom prefix for invoice number field (ZPL labels only). Up to 11 characters, including trailing spaces. Empty string indicates removal of default prefix. To use the default prefix, do not include this property. value: type: string maxLength: 40 description: >- Optional text to be printed on the shipping label for invoice number. Up to 40 characters. If provided, this will be used on the label instead of shipment.customs_declaration.invoice. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 30 characters | ref_sort: type: integer description: >- Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers. example: 2 type: object ShipmentExtraLasershipAttributesEnum: type: string enum: - TwoPersonDelivery - Explosive - Alcohol - Hazmat - ControlledSubstance - Refrigerated - DryIce - Perishable - NoRTS PoNumber: description: Specify the PO number field on the label (FedEx and UPS only). properties: prefix: type: string description: >- Custom prefix for PO number field (ZPL labels only). Up to 11 characters, including trailing spaces. Empty string indicates removal of default prefix. To use the default prefix, do not include this property. value: type: string maxLength: 40 description: >- Optional text to be printed on the shipping label for PO number. Up to 40 characters. If this is provided, reference_2 will be ignored. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 30 characters | ref_sort: type: integer description: >- Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers. example: 2 type: object ShipmentExtraReturnServiceTypeUPSEnum: type: string enum: - PRINT_AND_MAIL - ATTEMPT_1 - ATTEMPT_3 - ELECTRONIC_LABEL ShipmentExtraReturnServiceTypeLasershipEnum: type: string enum: - NO_RETURN RmaNumber: description: Specify the RMA number field on the label (FedEx and UPS only). properties: prefix: type: string description: >- Custom prefix for RMA number field (ZPL labels only). Up to 11 characters, including trailing spaces. Empty string indicates removal of default prefix. To use the default prefix, do not include this property. value: type: string maxLength: 40 description: >- Optional text to be printed on the shipping label for RMA number. Up to 40 characters. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 20 characters | ref_sort: type: integer description: >- Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers. example: 1 type: object AddressBase: description: Address represents the address as retrieved from the database properties: name: description: >- **required for purchase**
First and Last Name of the addressee **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Either company or name required; No length validation (first 35 chars printed on label) | example: Shwan Ippotle type: string maxLength: 100 company: example: Shippo type: string maxLength: 100 description: |- Company Name **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 35 characters; Either company or name required | street1: description: >- **required for purchase**
First street line. Usually street number and street name (except for DHL Germany, see street_no). **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | At least one street line required; Max 35 characters per line | example: 215 Clayton St. type: string maxLength: 121 street2: type: string maxLength: 100 description: >- Second street line. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | At least one street line required; Max 35 characters per line | street3: type: string maxLength: 100 example: '' description: >- Third street line. Only accepted for USPS international shipments, UPS domestic and UPS international shipments. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | At least one street line required; Max 35 characters per line | street_no: type: string example: '' description: >- Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany. city: description: >- **required for purchase**
Name of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates. Please bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state or a ZIP code (see below), if known, it will yield more accurate results. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Required; Max 35 characters | example: San Francisco type: string maxLength: 100 state: description: >- **required for purchase for some countries**
State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers only accept two or three character state abbreviations. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Required if country requires state; Max 2 characters for US, CA, PR | example: CA type: string maxLength: 100 zip: description: >- **required for purchase**
Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more accurate Rates. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 10 characters | example: '94117' type: string maxLength: 20 country: example: US type: string description: >- ISO 3166-1 alpha-2 country codes and country names can be used. For most consistent results, we recommend using country codes like `US` or `DE`. If using country names, please ensure they are spelled correctly and in English. Country names are converted to country codes. Refer to this guide for a list of country codes. Sending a country is always required. phone: example: +1 555 341 9393 type: string maxLength: 50 description: >- Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Required; Min 1, max 15 characters | | USPS | Sender phone required for shipments during label purchase; Min 8, max 15 digits | email: example: shippotle@shippo.com type: string maxLength: 254 description: |- E-mail address of the contact person, RFC3696/5321-compliant. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 80 characters | | USPS | Sender email required for shipments during label purchase | is_residential: example: true type: boolean metadata: example: Customer ID 123456 type: string maxLength: 100 description: >- A string of up to 100 characters that can be filled with any additional information you want to attach to the object. type: object AddressValidationResults: description: >- Object that contains information regarding if an address had been validated or not. Also contains any messages generated during validation. Children keys are is_valid(boolean) and messages(array). properties: is_valid: example: false type: boolean messages: items: $ref: '#/components/schemas/AddressValidationResultsMessage' type: array type: object CustomsExporterIdentification: description: >- Additional exporter identification that may be required to ship in certain countries properties: eori_number: example: PL123456790ABCDE type: string description: >- Economic Operators' Registration and Identification (EORI) number. Must start with a 2 character country code followed by a 6-17 character alphanumeric identifier (e.g. PL1234567890ABCDE). More information on EORI. tax_id: $ref: '#/components/schemas/CustomsTaxIdentification' type: object ParcelExtra: title: Parcel Extra x-tags: - Parcels description: >- An object holding optional extra services to be requested for each parcel in a multi-piece shipment. The following values are supported for the `extra` field of the parcel object. properties: COD: $ref: '#/components/schemas/COD' insurance: $ref: '#/components/schemas/ParcelInsurance' reference_1: type: string maxLength: 50 description: >- Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 40 characters (Express services); Max 30 characters (Ground services) | reference_2: type: string maxLength: 50 description: >- Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. **Carrier-Specific Constraints:** | Carrier | Constraints | |:---|:---| | FedEx | Max 30 characters | type: object WeightUnitEnum: description: The unit used for weight. enum: - g - kg - lb - oz example: lb type: string DistanceUnitEnum: enum: - cm - in - ft - m - mm - yd example: in type: string description: The measure unit used for length, width and height. ParcelTemplateFedExEnum: type: string title: FedEx Parcel Template enum: - FedEx_Box_10kg - FedEx_Box_25kg - FedEx_Box_Extra_Large_1 - FedEx_Box_Extra_Large_2 - FedEx_Box_Large_1 - FedEx_Box_Large_2 - FedEx_Box_Medium_1 - FedEx_Box_Medium_2 - FedEx_Box_Small_1 - FedEx_Box_Small_2 - FedEx_Envelope - FedEx_Padded_Pak - FedEx_Pak_1 - FedEx_Pak_2 - FedEx_Tube - FedEx_XL_Pak description: > |Token | Name | Dimensions| |:---|:---|:---| | FedEx_Box_10kg | FedEx® 10kg Box | 15.81 x 12.94 x 10.19 in| | FedEx_Box_25kg | FedEx® 25kg Box | 54.80 x 42.10 x 33.50 in| | FedEx_Box_Extra_Large_1 | FedEx® Extra Large Box (X1) | 11.88 x 11.00 x 10.75 in| | FedEx_Box_Extra_Large_2 | FedEx® Extra Large Box (X2) | 15.75 x 14.13 x 6.00 in| | FedEx_Box_Large_1 | FedEx® Large Box (L1) | 17.50 x 12.38 x 3.00 in| | FedEx_Box_Large_2 | FedEx® Large Box (L2) | 11.25 x 8.75 x 7.75 in| | FedEx_Box_Medium_1 | FedEx® Medium Box (M1) | 13.25 x 11.50 x 2.38 in| | FedEx_Box_Medium_2 | FedEx® Medium Box (M2) | 11.25 x 8.75 x 4.38 in| | FedEx_Box_Small_1 | FedEx® Small Box (S1) | 12.38 x 10.88 x 1.50 in| | FedEx_Box_Small_2 | FedEx® Small Box (S2) | 11.25 x 8.75 x 2.38 in| | FedEx_Envelope | FedEx® Envelope | 12.50 x 9.50 x 0.80 in| | FedEx_Padded_Pak | FedEx® Padded Pak | 11.75 x 14.75 x 2.00 in| | FedEx_Pak_1 | FedEx® Large Pak | 15.50 x 12.00 x 0.80 in| | FedEx_Pak_2 | FedEx® Small Pak | 12.75 x 10.25 x 0.80 in| | FedEx_Tube | FedEx® Tube | 38.00 x 6.00 x 6.00 in| | FedEx_XL_Pak | FedEx® Extra Large Pak | 17.50 x 20.75 x 2.00 in| ParcelTemplateUPSEnum: type: string title: UPS Parcel Template enum: - UPS_Box_10kg - UPS_Box_25kg - UPS_Express_Box - UPS_Express_Box_Large - UPS_Express_Box_Medium - UPS_Express_Box_Small - UPS_Express_Envelope - UPS_Express_Hard_Pak - UPS_Express_Legal_Envelope - UPS_Express_Pak - UPS_Express_Tube - UPS_Laboratory_Pak - UPS_MI_BPM - UPS_MI_BPM_Flat - UPS_MI_BPM_Parcel - UPS_MI_First_Class - UPS_MI_Flat - UPS_MI_Irregular - UPS_MI_Machinable - UPS_MI_MEDIA_MAIL - UPS_MI_Parcel_Post - UPS_MI_Priority - UPS_MI_Standard_Flat - UPS_Pad_Pak - UPS_Pallet description: > |Token | Name | Dimensions| |:---|:---|:---| | UPS_Box_10kg | Box 10kg | 410.00 x 335.00 x 265.00 mm| | UPS_Box_25kg | Box 25kg | 484.00 x 433.00 x 350.00 mm| | UPS_Express_Box | Express Box | 460.00 x 315.00 x 95.00 mm| | UPS_Express_Box_Large | Express Box Large | 18.00 x 13.00 x 3.00 in| | UPS_Express_Box_Medium | Express Box Medium | 15.00 x 11.00 x 3.00 in| | UPS_Express_Box_Small | Express Box Small | 13.00 x 11.00 x 2.00 in| | UPS_Express_Envelope | Express Envelope | 12.50 x 9.50 x 2.00 in| | UPS_Express_Hard_Pak | Express Hard Pak | 14.75 x 11.50 x 2.00 in| | UPS_Express_Legal_Envelope | Express Legal Envelope | 15.00 x 9.50 x 2.00 in| | UPS_Express_Pak | Express Pak | 16.00 x 12.75 x 2.00 in| | UPS_Express_Tube | Express Tube | 970.00 x 190.00 x 165.00 mm| | UPS_Laboratory_Pak | Laboratory Pak | 17.25 x 12.75 x 2.00 in| | UPS_MI_BPM | BPM (Mail Innovations - Domestic & International) | 0.00 x 0.00 x 0.00 in| | UPS_MI_BPM_Flat | BPM Flat (Mail Innovations - Domestic & International) | 0.00 x 0.00 x 0.00 in| | UPS_MI_BPM_Parcel | BPM Parcel (Mail Innovations - Domestic & International) | 0.00 x 0.00 x 0.00 in| | UPS_MI_First_Class | First Class (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_MI_Flat | Flat (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_MI_Irregular | Irregular (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_MI_Machinable | Machinable (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_MI_MEDIA_MAIL | Media Mail (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_MI_Parcel_Post | Parcel Post (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_MI_Priority | Priority (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_MI_Standard_Flat | Standard Flat (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in| | UPS_Pad_Pak | Pad Pak | 14.75 x 11.00 x 2.00 in| | UPS_Pallet | Pallet | 120.00 x 80.00 x 200.00 cm| ParcelTemplateUSPSEnum: type: string title: USPS Parcel Template enum: - USPS_FlatRateCardboardEnvelope - USPS_FlatRateEnvelope - USPS_FlatRateGiftCardEnvelope - USPS_FlatRateLegalEnvelope - USPS_FlatRatePaddedEnvelope - USPS_FlatRateWindowEnvelope - USPS_IrregularParcel - USPS_LargeFlatRateBoardGameBox - USPS_LargeFlatRateBox - USPS_APOFlatRateBox - USPS_LargeVideoFlatRateBox - USPS_MediumFlatRateBox1 - USPS_MediumFlatRateBox2 - USPS_RegionalRateBoxA1 - USPS_RegionalRateBoxA2 - USPS_RegionalRateBoxB1 - USPS_RegionalRateBoxB2 - USPS_SmallFlatRateBox - USPS_SmallFlatRateEnvelope - USPS_SoftPack description: > |Token | Name | Dimensions| |:---|:---|:---| | USPS_FlatRateCardboardEnvelope | Flat Rate Cardboard Envelope | 12.50 x 9.50 x 0.75 in | | USPS_FlatRateEnvelope | Flat Rate Envelope | 12.50 x 9.50 x 0.75 in | | USPS_FlatRateGiftCardEnvelope | Flat Rate Gift Card Envelope | 10.00 x 7.00 x 0.75 in | | USPS_FlatRateLegalEnvelope | Flat Rate Legal Envelope | 15.00 x 9.50 x 0.75 in | | USPS_FlatRatePaddedEnvelope | Flat Rate Padded Envelope | 12.50 x 9.50 x 1.00 in | | USPS_FlatRateWindowEnvelope | Flat Rate Window Envelope | 10.00 x 5.00 x 0.75 in | | USPS_IrregularParcel | Irregular Parcel | 0.00 x 0.00 x 0.00 in | | USPS_LargeFlatRateBoardGameBox | Large Flat Rate Board Game Box | 24.06 x 11.88 x 3.13 in | | USPS_LargeFlatRateBox | Large Flat Rate Box | 12.25 x 12.25 x 6.00 in | | USPS_APOFlatRateBox | APO/FPO/DPO Large Flat Rate Box | 12.25 x 12.25 x 6.00 in | | USPS_LargeVideoFlatRateBox | Flat Rate Large Video Box (Int'l only) | 9.60 x 6.40 x 2.20 in | | USPS_MediumFlatRateBox1 | Medium Flat Rate Box 1 | 11.25 x 8.75 x 6.00 in | | USPS_MediumFlatRateBox2 | Medium Flat Rate Box 2 | 14.00 x 12.00 x 3.50 in | | USPS_RegionalRateBoxA1 | Regional Rate Box A1 | 10.13 x 7.13 x 5.00 in | | USPS_RegionalRateBoxA2 | Regional Rate Box A2 | 13.06 x 11.06 x 2.50 in | | USPS_RegionalRateBoxB1 | Regional Rate Box B1 | 12.25 x 10.50 x 5.50 in | | USPS_RegionalRateBoxB2 | Regional Rate Box B2 | 16.25 x 14.50 x 3.00 in | | USPS_SmallFlatRateBox | Small Flat Rate Box | 8.69 x 5.44 x 1.75 in | | USPS_SmallFlatRateEnvelope | Small Flat Rate Envelope | 10.00 x 6.00 x 4.00 in | | USPS_SoftPack | Soft Pack Padded Envelope | Length and width defined in the Parcel| ParcelTemplateDHLeCommerceEnum: type: string title: DHL eCommerce Parcel Template enum: - DHLeC_Irregular - DHLeC_SM_Flats description: | |Token | Name | Dimensions| |:---|:---|:---| | DHLeC_Irregular | Irregular Shipment | 10.00 x 10.00 x 10.00 in| | DHLeC_SM_Flats | Flats | 27.00 x 17.00 x 17.00 in| ParcelTemplateDPDUKEnum: type: string title: DPD UK Parcel Template enum: - DPD_UK_Express_Pak description: | |Token | Name | Dimensions| |:---|:---|:---| | DPD_UK_Express_Pak| DPD UK Express Pak | 530.00 x 400.00 x 100.00 mm| ParcelTemplateAramexAustraliaEnum: type: string title: Aramex Australia Parcel Template enum: - Fastway_Australia_Satchel_A2 - Fastway_Australia_Satchel_A3 - Fastway_Australia_Satchel_A4 - Fastway_Australia_Satchel_A5 description: > |Token | Name | Dimensions| |:---|:---|:---| | Fastway_Australia_Satchel_A2 | Satchel A2 | 594.00 x 420.00 x 48.00 mm| | Fastway_Australia_Satchel_A3 | Satchel A3 | 420.00 x 297.00 x 64.00 mm| | Fastway_Australia_Satchel_A4 | Satchel A4 | 297.00 x 210.00 x 64.00 mm| | Fastway_Australia_Satchel_A5 | Satchel A5 | 210.00 x 148.00 x 64.00 mm| ServiceLevel: description: Contains details regarding the service level for the given rate. properties: name: example: Priority Mail Express type: string description: >- Name of the Rate's servicelevel, e.g. `International Priority` or `Standard Post`. A servicelevel commonly defines the transit time of a Shipment (e.g., Express vs. Standard), along with other properties. These names vary depending on the provider. terms: type: string description: Further clarification of the service. token: example: usps_priority_express type: string description: >- Token of the Rate's servicelevel, e.g. `usps_priority` or `fedex_ground`. See servicelevels. extended_token: type: string description: >- Unique, extended version of the Service Level "token". Guaranteed to be unique across all Service Levels, and may help offer insight into the specific Service Level it describes. type: object x-speakeasy-include: true DangerousGoodsBiologicalMaterial: description: Container for specifying the presence of biological material. properties: contains: type: boolean description: Indicates if the shipment contains biological material. type: object DangerousGoodsLithiumBatteries: description: Container for specifying the presence of lithium batteries. properties: contains: type: boolean description: Indicates if the shipment contains lithium batteries. type: object AddressValidationResultsMessage: properties: code: type: string example: Unknown Street description: >- See Address Validation Codes source: type: string example: Shippo Address Validator description: >- See Address Validation Source text: example: >- City, State and ZIP Code are valid, but street address is not a match. type: string type: example: address_warning type: string type: object CustomsTaxIdentification: description: >- Tax identification that may be required to ship in certain countries. Typically used to assess duties on goods that are crossing a border. properties: number: example: '123456789' type: string maxLength: 15 description: Tax identification number. type: example: EIN enum: - EIN - VAT - IOSS - ARN description: >- Type of tax identification. * `EIN` - Employer Identification Number, also known as a Federal Tax Identification Number. * `VAT` - Value Added Tax identification number. * `IOSS` - Import One-Stop Shop * `ARN` - Australian Taxation Office Reference Number type: object ParcelInsurance: description: >- To add insurance to your parcel, specify `amount`, `content` and `currency`.

If you do not want to add insurance to you parcel, do not set these parameters. properties: amount: description: Declared value of the goods you want to insure. example: '5.5' type: string content: description: Description of parcel content. example: Laptop type: string currency: description: >- Currency for the amount value. Currently only USD is supported for FedEx and UPS. example: USD type: string provider: description: >- To have insurance cover provided by a carrier directly instead of Shippo's provider (XCover), set provider to `FEDEX`, `UPS`, or `ONTRAC`. example: UPS type: string enum: - FEDEX - UPS - ONTRAC type: object securitySchemes: APIKeyHeader: type: apiKey in: header name: Authorization x-token-prefix: ShippoToken x-token-format: ShippoToken {token} x-default: 'ShippoToken ' description: | API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken Example: Authorization: ShippoToken shippo_live_abc123 ````