The address object

An address is a physical address. It can be used as a billing address, a shipping address or as the location of a delivery event.

FIELD

DESCRIPTION

address1 string, optional

Street address, including street number

address2
string, optional

Optional additional field for the street address

city
string, optional

City, town or village

zip
string, optional

Postal code (zip, postcode, Eircode, …)

country
string, optional

Country name. This is for presentation only and the below country_code field should be provided in priority

country_code
string, optional, 2 letter ISO code, e.g. FR or GB

Country code

state
string, optional

State name. This is for presentation only and the below state_code should be provided in priority

state_code
string, optional, 2 letter ISO code (US and CA), e.g. NY

State code (US and Canada only)

first_name
string, optional

Address first name

last_name
string, optional

Address last name

name
string, optional

Address full name

company_title
string, optional

Name of the company (for business addresses)