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 |
|
|
id |
| The address unique identifier |
links.self |
| The address endpoint URL |
attributes.billing_info |
| Customer's billing information (i.e. VAT number, codice fiscale). |
attributes.business |
| Indicates if it's a business or a personal address. |
attributes.city |
| Address city. |
attributes.company |
| Address company name (business). |
attributes.country_code |
| The international 2-letter country code as defined by the ISO 3166-1 standard. |
attributes.created_at |
| Time at which the resource was created. |
attributes.email |
| Email address. |
attributes.first_name |
| Address first name (personal). |
attributes.full_address |
| Compact description of the address location, without the full name. |
attributes.full_name |
| Company name (business) of first name and last name (personal). |
attributes.is_geocoded |
| Indicates if the address has been successfully geocoded. |
attributes.is_localized |
| Indicates if the latitude and logitude are present, either geocoded or manually updated. |
attributes.last_name |
| Address last name (personal). |
attributes.lat |
| 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 |
| Address line 1, i.e. Street address, PO Box. |
attributes.line_2 |
| Address line 2, i.e. Apartment, Suite, Building. |
attributes.lng |
| 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 |
| The map url of the geocoded address (if geocoded). |
attributes.metadata |
| 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 |
| Compact description of the address location, including the full name. |
attributes.notes |
| 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 |
| Phone number (including extension). |
attributes.provider_name |
| The geocoder provider name (either Google or Bing). |
attributes.reference |
| 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 |
| Any identifier of the third party system that defines the reference code. |
attributes.state_code |
| State, province or region code. |
attributes.static_map_url |
| The static map image url of the geocoded address (if geocoded). |
attributes.updated_at |
| Time at which the resource was last updated. |
attributes.zip_code |
| ZIP or postal code. |
relationships.events |
| The associated events. |
relationships.geocoder |
| The geocoder attached to the address, to be used for geocoding. |
relationships.tags |
| The associated tags. |
relationships.versions |
| The associated changes. |
meta.mode |
| The resource environment (can be one of |
Last updated