Addresses

The Addresses API allows you to organize customer addresses. Addresses are a sub-resource of a Customer. A Customer may have multiple addresses, such as home, work and neighbor. You are able to use a customer with an implicit Bearer token. This is recommend for client-side interactions. Or you can use a client_credentials Bearer token. This is recommended for back end interactions.

The Address object

Attributes

Attribute	Type	Description
id	string	The unique identifier for this address
type	string	The type represents the object being returned
first_name	string	The first name of the recipient on this address
last_name	string	The last name of the recipient on this address
name	string	The name for the address saved. Such as home, work or wife's office
phone_number	string	A phone number for this address
instructions	string	Any delivery instructions associated with this addresses
company_name	string	The company name at this address
line_1	string	Usually the street name
line_2	string	Usually the unit or apartment number
city	string	The city for this address
county	string	The county for this address
postcode	string	The ZIP, postcode or other postal reference for this address
country	string	A two digit code for this country address. This is a ISO 3166-2 standard.

Sample Response

{
  "id": "5f8da740-6680-463e-b31c-190b2db4bf9d",
  "type": "address",
  "name": "Home",
  "first_name": "Ron",
  "last_name": "Swanson",
  "company_name": "",
  "phone_number": "[phone]",
  "line_1": "1 Sunny Street",
  "line_2": "Sunny Place",
  "city": "Sunny Town",
  "postcode": "SU33 1YY",
  "county": "Sunnyville",
  "country": "GB",
  "instructions": "Leave in the shed",
  "links": {
    "self":
      "https://api.moltin.com/v2/addresses/5f8da740-6680-463e-b31c-190b2db4bf9d"
  },
  "meta": {
    "timestamps": {
      "created_at": "2018-05-04T15:20:09.734Z",
      "updated_at": "2018-05-04T15:20:09.734Z"
    }
  }
}