API reference
The address object
A comprehensive list of the address resource's attributes and relationships
An address object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/addresses endpoint.

Fields

Field
Type
Description
type
string
addresses
id
string
The address unique identifier
links.self
string
The address endpoint URL
attributes.business
boolean
Indicates if it's a business or a personal address
attributes.first_name
string
Address first name (personal)
attributes.last_name
string
Address last name (personal)
attributes.company
string
Address company name (business)
attributes.full_name
string
Company name (business) of first name and last name (personal)
attributes.line_1
string
Address line 1, i.e. Street address, PO Box
attributes.line_2
string
Address line 2, i.e. Apartment, Suite, Building
attributes.city
string
Address city
attributes.zip_code
string
ZIP or postal code
attributes.state_code
string
State, province or region code.
attributes.country_code
string
The international 2-letter country code as defined by the ISO 3166-1 standard
attributes.phone
string
Phone number (including extension).
attributes.full_address
string
Compact description of the address location, without the full name
attributes.name
string
Compact description of the address location, including the full name
attributes.email
string
Email address.
attributes.notes
string
A free notes attached to the address. When used as a shipping address, this can be useful to let the customers add specific delivery instructions.
attributes.lat
float
The address geocoded latitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.
Copy link
Contents
Fields