Create a new address

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.

SchemasOperations

List all addresses

Request

Returns a list of all address objects that have been created in this account.

Security

APIKeyHeader

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/addresses/ \
 -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"

Responses

Bodyapplication/json

nextstring

Example: "baseurl?page=3&results=10"

previousstring

Example: "baseurl?page=1&results=10"

resultsArray of objects(AddressTo)

Response

application/json

{
  "next": "baseurl?page=3&results=10",
  "previous": "baseurl?page=1&results=10",
  "results": [
    { … }
  ]
}

Create a new address

Request

Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.

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

Address details.

namestring<= 100 characters

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"

companystring<= 100 characters

Company Name

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Max 35 characters; Either company or name required

Example: "Shippo"

street1string<= 121 characters

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

street2string<= 100 characters

Second street line.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	At least one street line required; Max 35 characters per line

street3string<= 100 characters

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

Example: ""

street_nostring

Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany.

Example: ""

citystring<= 100 characters

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"

statestring<= 100 characters

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"

zipstring<= 20 characters

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"

countrystringrequired

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.

Example: "US"

phonestring<= 50 characters

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

Example: "+1 555 341 9393"

emailstring<= 254 characters

E-mail address of the contact person, RFC3696/5321-compliant.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Max 80 characters

Example: "shippotle@shippo.com"

is_residentialboolean

Example: true

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: "Customer ID 123456"

validateboolean

Set to true to validate Address object.

Example: true

curl https://api.goshippo.com/addresses/ \
  -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396" \
  -d name="Shawn Ippotle" \
  -d company="Shippo" \
  -d street1="215 Clayton St." \
  -d street2="" \
  -d city="San Francisco" \
  -d state="CA" \
  -d zip=94117 \
  -d country="US" \
  -d phone="+1 555 341 9393" \
  -d email="shippotle@shippo.com"\
  -d is_residential=True\
  -d metadata="Customer ID 123456"

Responses

Bodyapplication/json

namestring<= 100 characters

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"

companystring<= 100 characters

Company Name

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Max 35 characters; Either company or name required

Example: "Shippo"

street1string<= 121 characters

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

street2string<= 100 characters

Second street line.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	At least one street line required; Max 35 characters per line

street3string<= 100 characters

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

Example: ""

street_nostring

Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany.

Example: ""

citystring<= 100 characters

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"

statestring<= 100 characters

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"

zipstring<= 20 characters

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"

countrystringrequired

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.

Example: "US"

phonestring<= 50 characters

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

Example: "+1 555 341 9393"

emailstring<= 254 characters

E-mail address of the contact person, RFC3696/5321-compliant.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Max 80 characters

Example: "shippotle@shippo.com"

is_residentialboolean

Example: true

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: "Customer ID 123456"

is_completeboolean

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.

Example: true

latitudenumber or string

Latitude of address

longitudenumber or string

Longitude of address

object_createdstring(date-time)

Date and time of Address creation.

Example: "2014-07-09T02:19:13.174Z"

object_idstring

Unique identifier of the given Address object. This ID is required to create a Shipment object.

Example: "d799c2679e644279b59fe661ac8fa488"

object_ownerstring

Username of the user who created the Address object.

Example: "shippotle@shippo.com"

object_updatedstring(date-time)

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.

Example: "2014-07-09T02:19:13.174Z"

validation_resultsobject(AddressValidationResults)

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

testboolean

Indicates whether the object has been created in test mode.

Example: false

Response

application/json

{
  "name": "Shwan Ippotle",
  "company": "Shippo",
  "street1": "215 Clayton St.",
  "street2": "string",
  "street3": "",
  "street_no": "",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94117",
  "country": "US",
  "phone": "+1 555 341 9393",
  "email": "shippotle@shippo.com",
  "is_residential": true,
  "metadata": "Customer ID 123456",
  "is_complete": true,
  "latitude": 0,
  "longitude": 0,
  "object_created": "2014-07-09T02:19:13.174Z",
  "object_id": "d799c2679e644279b59fe661ac8fa488",
  "object_owner": "shippotle@shippo.com",
  "object_updated": "2014-07-09T02:19:13.174Z",
  "validation_results": {
    "is_valid": false,
    "messages": [ … ]
  },
  "test": false
}

Retrieve an address

Request

Returns an existing address using an object ID.

Security

APIKeyHeader

Path

AddressIdstringrequired

Object ID of the address

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/addresses/d799c2679e644279b59fe661ac8fa488/ \
  -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"

Responses

Bodyapplication/json

namestring<= 100 characters

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"

companystring<= 100 characters

Company Name

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Max 35 characters; Either company or name required

Example: "Shippo"

street1string<= 121 characters

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

street2string<= 100 characters

Second street line.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	At least one street line required; Max 35 characters per line

street3string<= 100 characters

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

Example: ""

street_nostring

Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany.

Example: ""

citystring<= 100 characters

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"

statestring<= 100 characters

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"

zipstring<= 20 characters

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"

countrystringrequired

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.

Example: "US"

phonestring<= 50 characters

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

Example: "+1 555 341 9393"

emailstring<= 254 characters

E-mail address of the contact person, RFC3696/5321-compliant.

Carrier-Specific Constraints:

Carrier	Constraints
FedEx	Max 80 characters

Example: "shippotle@shippo.com"

is_residentialboolean

Example: true

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: "Customer ID 123456"

is_completeboolean

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.

Example: true

latitudenumber or string

Latitude of address

longitudenumber or string

Longitude of address

object_createdstring(date-time)

Date and time of Address creation.

Example: "2014-07-09T02:19:13.174Z"

object_idstring

Unique identifier of the given Address object. This ID is required to create a Shipment object.

Example: "d799c2679e644279b59fe661ac8fa488"

object_ownerstring

Username of the user who created the Address object.

Example: "shippotle@shippo.com"

object_updatedstring(date-time)

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.

Example: "2014-07-09T02:19:13.174Z"

validation_resultsobject(AddressValidationResults)

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

testboolean

Indicates whether the object has been created in test mode.

Example: false

Response

application/json

{
  "name": "Shwan Ippotle",
  "company": "Shippo",
  "street1": "215 Clayton St.",
  "street2": "string",
  "street3": "",
  "street_no": "",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94117",
  "country": "US",
  "phone": "+1 555 341 9393",
  "email": "shippotle@shippo.com",
  "is_residential": true,
  "metadata": "Customer ID 123456",
  "is_complete": true,
  "latitude": 0,
  "longitude": 0,
  "object_created": "2014-07-09T02:19:13.174Z",
  "object_id": "d799c2679e644279b59fe661ac8fa488",
  "object_owner": "shippotle@shippo.com",
  "object_updated": "2014-07-09T02:19:13.174Z",
  "validation_results": {
    "is_valid": false,
    "messages": [ … ]
  },
  "test": false
}

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

Customs Items

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

SchemasOperations

Customs Declarations

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

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

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.

SchemasOperations

Refunds

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

SchemasOperations

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.

SchemasOperations

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

SchemasOperations

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.

SchemasOperations

Carriers

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
cdl	CDL
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

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

Shippo external API. (2018-02-08)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Overview

API Resources

Authentication

Request & Response Data

REST & Disposable Objects

API Version

Addresses

List all addresses

Request

Responses

Was this helpful?

Create a new address

Request

Responses

Was this helpful?

Retrieve an address

Request

Responses

Was this helpful?

Parcels

Carrier Parcel Templates

User Parcel Templates

Shipments

Rates

Transactions (shipping labels)

Batches

Tracking Status

Webhooks

Customs Items

Customs Declarations

Carrier Accounts

Manifests

Pickups

Orders (beta)

Refunds

Service Groups

Rates at Checkout

Shippo Accounts

Carriers

Service Levels

Parcel Templates

Address Validation Source

Address Validation Codes

Customs Declaration B13A Filing Option

Customs Declaration Contents Type

Customs Declaration EEL/PFC

Customs Declaration Incoterm

Customs Declaration Non Delivery Option

Shippo external API. (2018-02-08)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude