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.billing_info	string	Customer's billing information (i.e. VAT number, codice fiscale).
attributes.business	boolean	Indicates if it's a business or a personal address.
attributes.city	string	Address city.
attributes.company	string	Address company name (business).
attributes.country_code	string	The international 2-letter country code as defined by the ISO 3166-1 standard.
attributes.created_at	datetime	Time at which the resource was created.
attributes.email	string	Email address.
attributes.first_name	string	Address first name (personal).
attributes.full_address	string	Compact description of the address location, without the full name.
attributes.full_name	string	Company name (business) of first name and last name (personal).
attributes.is_geocoded	boolean	Indicates if the address has been successfully geocoded.
attributes.is_localized	boolean	Indicates if the latitude and logitude are present, either geocoded or manually updated.
attributes.last_name	string	Address last name (personal).
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.
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.lng	float	The address geocoded longitude. This is automatically generated when creating a shipping/billing address for an order and a valid geocoder is attached to the order's market.
attributes.map_url	string	The map url of the geocoded address (if geocoded).
attributes.metadata	object	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
attributes.name	string	Compact description of the address location, including the full name.
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.phone	string	Phone number (including extension).
attributes.provider_name	string	The geocoder provider name (either Google or Bing).
attributes.reference	string	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	string	Any identifier of the third party system that defines the reference code.
attributes.state_code	string	State, province or region code.
attributes.static_map_url	string	The static map image url of the geocoded address (if geocoded).
attributes.updated_at	datetime	Time at which the resource was last updated.
attributes.zip_code	string	ZIP or postal code.
relationships.events	array	The associated events.
relationships.geocoder	object	The geocoder attached to the address, to be used for geocoding.
relationships.tags	array	The associated tags.
relationships.versions	array	The associated changes.
meta.mode	string	The resource environment (can be one of test or live)