Address Base Object

An address object representing address information.

NameTypeNullable?Description
namestring

Name of the contact.

first_namestring

First or given name of the contact.

last_namestring

Last or family name of the contact.

emailstring

Email of the contact.

phone_numberstring

Phone number of the contact. Cannot include newline chars.

company_namestring

Company name, if applicable. Cannot include newline chars.

address_lines[]string[]

Address fields separated by line. Up to 100 chars per line. Cannot include newline chars.

city_localitystring

City or locality. Cannot contain newline chars.

state_provincestring

State or province. Cannot contain newline chars.

postal_codestring

Zip or postal code. Cannot include newline chars.

country_code

country code string

The ISO 3166 country code for the country of origin. This is usually the same as countryOfManufacture, but some countries distinguish between the two for certain products.

address_residential_indicatorstring

Indicates whether the address is residential or commercial.

Valid values include the following:

  • unknown
  • yes
  • no
is_euboolean

Indicates whether the country of the shipment address is a member of the EU.

address_metadataobject

Schemaless object representing the metadata related to this address.

Shipping Address Object

This address object is used in places related to shipments like ship_to and ship_from in CreateLabel().

This object extends the Address Base.

NameTypeNullable?Description
...Address Base

address base

All fields described in the address base defined above.

tax_identifiersobject

Tax IDs associated with the contact related to this address.

tax_identifiers.idstring

Identification number.

tax_identifiers.typestring

The Tax ID type.

Valid values include the following:

  • tin - Tax Identification Number
  • ein - Employer Identification Number
  • ssn - Social Security Number
  • vat - Value Added Tax Identification Number
  • eori - Economic Operators Registration and Identification Number
  • ioss - Import One-Stop Shop Number
  • pan - Permanent Account Number
  • voec - Norway's VAT on E-Commerce number
tax_identifiers   .registration_countystring

The country where the Tax ID is registered with.

tax_identifiers   .descriptionstring

Description of the tax ID that may give the customs agent more context.

Pickup Location Details Object

Pickup/Dropoff location address used by carriers.

NameTypeNullable?Description
pickup_address

shipping address object

The physical address of the warehouse or pickup address.

location_notesstring

Human readable location information for the driver to find the location.

pickup_optionsobject

Custom options that are used by the carrier to determine pickup locations.