Skip to content
/
Retrieve a batch

Shippo external API. (2018-02-08)

Use this API to integrate with the Shippo service

Download OpenAPI description
public-api.json
public-api.yaml
Overview
URL
https://goshippo.com/contact/
Languages
Servers
https://api.goshippo.com

Overview

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 <token> 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.

Addresses

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.

Schemas
Operations

Parcels

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.

Schemas
Operations

Carrier Parcel Templates

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.

Schemas
Operations

User Parcel Templates

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.

Schemas
Operations

Shipments

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.

Schemas
Operations

Rates

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.

Schemas
Operations

Transactions (shipping labels)

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.

Schemas
Operations

Batches

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.

Schemas
Operations

Create a batch

Request

Creates a new batch object for purchasing shipping labels for many shipments at once. Batches are created asynchronously. This means that the API response won't include your batch shipments yet. You need to retrieve the batch later to verify that all batch shipments are valid.

Security
APIKeyHeader
Headers
SHIPPO-API-VERSIONstring

Optional string used to pick a non-default API version to use. See our API version guide.

Example: 2018-02-08
Bodyapplication/jsonrequired

Batch details.

default_carrier_accountstringrequired

ID of the Carrier Account object to use as the default for all shipments in this Batch. The carrier account can be changed on a per-shipment basis by changing the carrier_account in the corresponding BatchShipment object.

Example: "078870331023437cb917f5187429b093"
default_servicelevel_tokenstringrequired

Token of the service level to use as the default for all shipments in this Batch. The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the corresponding BatchShipment object. Servicelevel tokens can be found here.

Example: "usps_priority"
label_filetypestring(LabelFileTypeEnum)

Print format of the label. If empty, will use the default format set from the Shippo dashboard.

Enum"PNG""PNG_2.3x7.5""PDF""PDF_2.3x7.5""PDF_4x6""PDF_4x8""PDF_A4""PDF_A5""PDF_A6""ZPLII"
metadatastring<= 100 characters

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

Example: "BATCH #1"
batch_shipmentsArray of objects(BatchShipmentCreateRequest)required

Array of BatchShipment objects. The response keeps the same order as in the request array.

curl https://api.goshippo.com/batches/  \
-H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396" \
-H "Content-Type: application/json"  \
-d '{
      "default_carrier_account": "078870331023437cb917f5187429b093",
      "default_servicelevel_token": "usps_priority",
      "label_filetype": "PDF_4x6",
      "metadata": "BATCH #170",
      "batch_shipments": [
        {
          "shipment": {    
            "address_from": {
              "name": "Mr Hippo",
              "street1": "965 Mission St",
              "street2": "Ste 201",
              "city": "San Francisco",
              "state": "CA",
              "zip": "94103",
              "country": "US",
              "phone": "4151234567",
              "email": "mrhippo@shippo.com"
            },
            "address_to": {
              "name": "Mrs Hippo",
              "company": "",
              "street1": "Broadway 1",
              "street2": "",
              "city": "New York",
              "state": "NY",
              "zip": "10007",
              "country": "US",
              "phone": "4151234567",
              "email": "mrshippo@shippo.com"
            },
            "parcels": [{
              "length": "5",
              "width": "5",
              "height": "5",
              "distance_unit": "in",
              "weight": "2",
              "mass_unit": "oz"
            }]
          }
        },
        {
          "shipment": {    
            "address_from": {
              "name": "Mr Hippo",
              "street1": "1092 Indian Summer Ct",
              "city": "San Jose",
              "state": "CA",
              "zip": "95122",
              "country": "US",
              "phone": "4151234567",
              "email": "mrhippo@shippo.com"
            },
            "address_to": {
              "name": "Mrs Hippo",
              "company": "",
              "street1": "Broadway 1",
              "street2": "",
              "city": "New York",
              "state": "NY",
              "zip": "10007",
              "country": "US",
              "phone": "4151234567",
              "email": "mrshippo@shippo.com"
            },
            "parcels": [{
              "length": "5",
              "width": "5",
              "height": "5",
              "distance_unit": "in",
              "weight": "20",
              "mass_unit": "lb"
            }]
          },
          "carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
          "servicelevel_token": "fedex_2_day"
        }
      ]
    }'

Responses

Bodyapplication/json
default_carrier_accountstringrequired

ID of the Carrier Account object to use as the default for all shipments in this Batch. The carrier account can be changed on a per-shipment basis by changing the carrier_account in the corresponding BatchShipment object.

Example: "078870331023437cb917f5187429b093"
default_servicelevel_tokenstringrequired

Token of the service level to use as the default for all shipments in this Batch. The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the corresponding BatchShipment object. Servicelevel tokens can be found here.

Example: "usps_priority"
label_filetypestring(LabelFileTypeEnum)

Print format of the label. If empty, will use the default format set from the Shippo dashboard.

Enum"PNG""PNG_2.3x7.5""PDF""PDF_2.3x7.5""PDF_4x6""PDF_4x8""PDF_A4""PDF_A5""PDF_A6""ZPLII"
metadatastring<= 100 characters

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

Example: "BATCH #1"
batch_shipmentsobject(BatchShipmentPaginatedList)required

Array of BatchShipment objects. The response keeps the same order as in the request array.

label_urlArray of stringsrequired

An array of URLs each pointing to a merged file of 100 labels each

object_createdstringrequired

Date and time of Batch creation

Example: "2016-01-04T00:15:44.394Z"
object_idstringrequired

Unique identifier of the given Batch object

Example: "5ef63c54f5bf45d3b1f8fb37dcb1c5f4"
object_ownerstringrequired

Username of the user who created the Batch object.

Example: "shippo@shippo.com"
object_resultsobjectrequired

An object containing the following counts:
creation_succeeded
creation_failed
purchase_succeeded
purchase_failed

object_updatedstringrequired

Date and time of last update to the Batch

Example: "2016-01-04T00:48:13.841Z"
statusstringrequired

Batches that are VALIDATING are being created and validated
VALID batches can be purchased
INVALID batches cannot be purchased, INVALID BatchShipments must be removed
Batches that are in the PURCHASING state are being purchased
PURCHASED batches are finished purchasing.

Enum"VALIDATING""VALID""INVALID""PURCHASING""PURCHASED"
Example: "VALID"
testboolean
Example: false
Response
application/json
{
  "default_carrier_account": "078870331023437cb917f5187429b093",
  "default_servicelevel_token": "usps_priority",
  "label_filetype": "PDF_4x6",
  "metadata": "BATCH #1",
  "batch_shipments": {
    "next": "baseurl?page=3&results=10",
    "previous": "baseurl?page=1&results=10",
    "results": [ … ]
  },
  "label_url": [
    "string"
  ],
  "object_created": "2016-01-04T00:15:44.394Z",
  "object_id": "5ef63c54f5bf45d3b1f8fb37dcb1c5f4",
  "object_owner": "shippo@shippo.com",
  "object_results": {
    "creation_failed": 3,
    "creation_succeeded": 5,
    "purchase_failed": 0,
    "purchase_succeeded": 0
  },
  "object_updated": "2016-01-04T00:48:13.841Z",
  "status": "VALID",
  "test": false
}

Retrieve a batch

Request

Returns a batch using an object ID.
Batch shipments are displayed 100 at a time. You can iterate through each page using the ?page= query parameter. You can also filter based on batch shipment status, for example, by passing a query param like ?object_results=creation_failed.
For more details on filtering results, see our guide on filtering.

Security
APIKeyHeader
Path
BatchIdstringrequired

Object ID of the batch

Query
pageinteger(int64)

The page number you want to select

Default 1
resultsinteger(int64)<= 100

The number of results to return per page (max 100, default 5)

Default 5
Headers
SHIPPO-API-VERSIONstring

Optional string used to pick a non-default API version to use. See our API version guide.

Example: 2018-02-08
curl https://api.goshippo.com/batches/<BATCH OBJECT ID>?page=2&object_results=creation_failed \
-H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"

Responses

Bodyapplication/json
default_carrier_accountstringrequired

ID of the Carrier Account object to use as the default for all shipments in this Batch. The carrier account can be changed on a per-shipment basis by changing the carrier_account in the corresponding BatchShipment object.

Example: "078870331023437cb917f5187429b093"
default_servicelevel_tokenstringrequired

Token of the service level to use as the default for all shipments in this Batch. The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the corresponding BatchShipment object. Servicelevel tokens can be found here.

Example: "usps_priority"
label_filetypestring(LabelFileTypeEnum)

Print format of the label. If empty, will use the default format set from the Shippo dashboard.

Enum"PNG""PNG_2.3x7.5""PDF""PDF_2.3x7.5""PDF_4x6""PDF_4x8""PDF_A4""PDF_A5""PDF_A6""ZPLII"
metadatastring<= 100 characters

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

Example: "BATCH #1"
batch_shipmentsobject(BatchShipmentPaginatedList)required

Array of BatchShipment objects. The response keeps the same order as in the request array.

label_urlArray of stringsrequired

An array of URLs each pointing to a merged file of 100 labels each

object_createdstringrequired

Date and time of Batch creation

Example: "2016-01-04T00:15:44.394Z"
object_idstringrequired

Unique identifier of the given Batch object

Example: "5ef63c54f5bf45d3b1f8fb37dcb1c5f4"
object_ownerstringrequired

Username of the user who created the Batch object.

Example: "shippo@shippo.com"
object_resultsobjectrequired

An object containing the following counts:
creation_succeeded
creation_failed
purchase_succeeded
purchase_failed

object_updatedstringrequired

Date and time of last update to the Batch

Example: "2016-01-04T00:48:13.841Z"
statusstringrequired

Batches that are VALIDATING are being created and validated
VALID batches can be purchased
INVALID batches cannot be purchased, INVALID BatchShipments must be removed
Batches that are in the PURCHASING state are being purchased
PURCHASED batches are finished purchasing.

Enum"VALIDATING""VALID""INVALID""PURCHASING""PURCHASED"
Example: "VALID"
testboolean
Example: false
Response
application/json
{
  "default_carrier_account": "078870331023437cb917f5187429b093",
  "default_servicelevel_token": "usps_priority",
  "label_filetype": "PDF_4x6",
  "metadata": "BATCH #1",
  "batch_shipments": {
    "next": "baseurl?page=3&results=10",
    "previous": "baseurl?page=1&results=10",
    "results": [ … ]
  },
  "label_url": [
    "string"
  ],
  "object_created": "2016-01-04T00:15:44.394Z",
  "object_id": "5ef63c54f5bf45d3b1f8fb37dcb1c5f4",
  "object_owner": "shippo@shippo.com",
  "object_results": {
    "creation_failed": 3,
    "creation_succeeded": 5,
    "purchase_failed": 0,
    "purchase_succeeded": 0
  },
  "object_updated": "2016-01-04T00:48:13.841Z",
  "status": "VALID",
  "test": false
}

Add shipments to a batch

Request

Adds batch shipments to an existing batch.

Security
APIKeyHeader
Path
BatchIdstringrequired

Object ID of the batch

Headers
SHIPPO-API-VERSIONstring

Optional string used to pick a non-default API version to use. See our API version guide.

Example: 2018-02-08
Bodyapplication/jsonrequired

Array of shipments to add to the batch

Array [
carrier_accountstring

Object ID of the carrier account to be used for this shipment (will override batch default)

Example: "a4391cd4ab974f478f55dc08b5c8e3b3"
metadatastring<= 100 characters

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

Example: "SHIPMENT #1"
servicelevel_tokenstring

A token that sets the shipping method for the batch, overriding the batch default. Servicelevel tokens can be found in this list or at this endpoint.

Example: "fedex_ground"
shipmentobject(ShipmentCreateRequest)required
]
curl -X POST https://api.goshippo.com/batches/<BATCH OBJECT ID>/add_shipments \
-H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396" \
-H "Content-Type: application/json"  \
-d '[
        {
          "shipment": {    
            "address_from": {
              "name": "Mr Hippo",
              "street1": "965 Mission St",
              "street2": "Ste 201",
              "city": "San Francisco",
              "state": "CA",
              "zip": "94103",
              "country": "US",
              "phone": "4151234567",
            },
            "address_to": {
              "name": "Hippo Jr",
              "street1": "915 Broadway",
              "street2": "19th Floor",
              "city": "New York",
              "state": "NY",
              "zip": "10010",
              "country": "US",
              "phone": "2129947880",
            },
            "parcels": [{
              "length": "12",
              "width": "12",
              "height": "12",
              "distance_unit": "in",
              "weight": "12",
              "mass_unit": "oz"
            }]
          }
        },
        {
          "shipment": {    
            "address_from": {
              "name": "Ms Hippo",
              "street1": "1092 Indian Summer Ct",
              "city": "San Jose",
              "state": "CA",
              "zip": "95122",
              "country": "US",
              "phone": "4151234567",
            },
            "address_to": {
              "name": "Mr Hippo",
              "street1": "965 Mission St",
              "street2": "Ste 201",
              "city": "San Francisco",
              "state": "CA",
              "zip": "94103",
              "country": "US",
              "phone": "4151234567",
            },
            "parcels": [{
              "length": "5",
              "width": "5",
              "height": "5",
              "distance_unit": "in",
              "weight": "2",
              "mass_unit": "lb"
            }]
          },
          "carrier_account": "a4391cd4ab974f478f55dc08b5c8e3b3",
          "servicelevel_token": "fedex_2_day"
        }
      ]'

Responses

Bodyapplication/json
default_carrier_accountstringrequired

ID of the Carrier Account object to use as the default for all shipments in this Batch. The carrier account can be changed on a per-shipment basis by changing the carrier_account in the corresponding BatchShipment object.

Example: "078870331023437cb917f5187429b093"
default_servicelevel_tokenstringrequired

Token of the service level to use as the default for all shipments in this Batch. The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the corresponding BatchShipment object. Servicelevel tokens can be found here.

Example: "usps_priority"
label_filetypestring(LabelFileTypeEnum)

Print format of the label. If empty, will use the default format set from the Shippo dashboard.

Enum"PNG""PNG_2.3x7.5""PDF""PDF_2.3x7.5""PDF_4x6""PDF_4x8""PDF_A4""PDF_A5""PDF_A6""ZPLII"
metadatastring<= 100 characters

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

Example: "BATCH #1"
batch_shipmentsobject(BatchShipmentPaginatedList)required

Array of BatchShipment objects. The response keeps the same order as in the request array.

label_urlArray of stringsrequired

An array of URLs each pointing to a merged file of 100 labels each

object_createdstringrequired

Date and time of Batch creation

Example: "2016-01-04T00:15:44.394Z"
object_idstringrequired

Unique identifier of the given Batch object

Example: "5ef63c54f5bf45d3b1f8fb37dcb1c5f4"
object_ownerstringrequired

Username of the user who created the Batch object.

Example: "shippo@shippo.com"
object_resultsobjectrequired

An object containing the following counts:
creation_succeeded
creation_failed
purchase_succeeded
purchase_failed

object_updatedstringrequired

Date and time of last update to the Batch

Example: "2016-01-04T00:48:13.841Z"
statusstringrequired

Batches that are VALIDATING are being created and validated
VALID batches can be purchased
INVALID batches cannot be purchased, INVALID BatchShipments must be removed
Batches that are in the PURCHASING state are being purchased
PURCHASED batches are finished purchasing.

Enum"VALIDATING""VALID""INVALID""PURCHASING""PURCHASED"
Example: "VALID"
testboolean
Example: false
Response
application/json
{
  "default_carrier_account": "078870331023437cb917f5187429b093",
  "default_servicelevel_token": "usps_priority",
  "label_filetype": "PDF_4x6",
  "metadata": "BATCH #1",
  "batch_shipments": {
    "next": "baseurl?page=3&results=10",
    "previous": "baseurl?page=1&results=10",
    "results": [ … ]
  },
  "label_url": [
    "string"
  ],
  "object_created": "2016-01-04T00:15:44.394Z",
  "object_id": "5ef63c54f5bf45d3b1f8fb37dcb1c5f4",
  "object_owner": "shippo@shippo.com",
  "object_results": {
    "creation_failed": 3,
    "creation_succeeded": 5,
    "purchase_failed": 0,
    "purchase_succeeded": 0
  },
  "object_updated": "2016-01-04T00:48:13.841Z",
  "status": "VALID",
  "test": false
}

Tracking Status


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.

Schemas
Operations

Webhooks

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.

Schemas
Operations

Customs Items

Customs declarations are relevant information, including one or multiple customs items, you need to provide for customs clearance for your international shipments.

Schemas
Operations

Customs Declarations

Customs declarations are relevant information, including one or multiple customs items, you need to provide for customs clearance for your international shipments.

Schemas
Operations

Carrier Accounts

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.

Schemas
Operations

Manifests

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.

Schemas
Operations

Pickups

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.

Schemas
Operations

Orders (beta)

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.

Schemas
Operations

Refunds

Refunds are reimbursements for successfully created but unused shipping labels or other charges.

Schemas
Operations

Service Groups

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.

Schemas
Operations

Rates at Checkout

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).

Schemas
Operations

Shippo Accounts

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.

Schemas
Operations

Carriers

TokenCarrier name
airterraAirterra
apc_postalAPC Postal
apgAPG
aramexAramex
asendia_usAsendia US
australia_postAustralia Post (also used for Startrack)
axlehireJitsu
better_trucksBetterTrucks
borderguruBorderGuru
boxberryBoxberry
bringBring (also used for Posten Norge)
canada_postCanada Post
cdlCDL
chronopostChronopost
collect_plusCollectPlus
correios_brCorreiosBR
correos_espanaCorreos España
colissimoColissimo
deutsche_postDeutsche Post
dhl_beneluxDHL Benelux
dhl_ecommerceDHL eCommerce
dhl_expressDHL Express
dhl_germany_c2cDHL Germany C2C
dhl_germanyDHL Germany
dpd_deDPD GERMANY
dpd_ukDPD UK
estafetaEstafeta
fastway_australiaAramex
fedexFedEx
globegisticsGlobegistics (now Asendia)
gls_usGLS US
gophrGophr
gsoGSO
hermes_germany_b2cHermes Germany B2C
hermes_ukEvri UK
hongkong_postHongkong Post
lasershipLaserShip
lsoLSO
mondial_relayMondial Relay
new_zealand_postNew Zealand Post (also used for Pace and CourierPost)
nippon_expressNippon Express
ontracOnTrac
parcelforceParcelforce
passportPassport
pcfPCF
poste_italianePoste Italiane
postiPosti
purolatorPurolator
royal_mailRoyal Mail
royal_mail_sfRoyal Mail Storefeeder
rr_donnelleyePost Global
russian_postRussian Post
skypostalSkyPostal
stuartStuart
swyftSwyft
udsUDS (United Delivery Service)
upsUPS
uspsUSPS
vehoVeho

Service Levels

Service levels represent the shipping service type for each carrier. Use the tokens below when creating shipments.

Parcel Templates

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.

Address Validation Source

Source of the address validation message.

Allowed values:

  • Shippo Address Validator
  • UPS

Address Validation Codes

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

Customs Declaration B13A Filing Option

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

Customs Declaration Contents Type

Type of goods of the shipment.

Allowed values:

  • DOCUMENTS
  • GIFT
  • SAMPLE
  • MERCHANDISE
  • HUMANITARIAN_DONATION
  • RETURN_MERCHANDISE
  • OTHER

Customs Declaration EEL/PFC

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

Customs Declaration Incoterm

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

Customs Declaration Non Delivery Option

Indicates how the carrier should proceed in case the shipment can't be delivered.

Allowed values:

  • ABANDON
  • RETURN