customer_address

Collection: customer_addresses

An address saved for a customer. If using multiship, these will be all the addresses used for this customer and the address_name is the shipto value used on the items. There will also be a Default Billing Address and Default Shipping Address for each customer.

Required Scopes

Full store_full_access
Read customers_read
Write customers_write

Actions

GET View a customer address
PATCH Update a customer address (send only the properties you want to modify)
PUT Replace a customer address (send the entire representation)
DELETE Delete a customer address
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (16)

ignore_address_restrictions Boolean · Optional

By default, the country value must be valid according to the store's location_filtering value in the template_config. For instance, if your store is configured to only allow shipping and billing to the US, attempting to set the country to CA (Canada) will error. If true is passed in, the country can be any valid values. For customer_address resources that aren't the default shipping or billing, the validation will assume the shipping restrictions. NOTE: This does not currently take the region filtering into account. Defaults to false.

address_name String · Required · max 100

The name of this address. This is also the value used as the shipto entry for a multiship item.

Must be unique per customer.

first_name String · max 50

The given name associated with this address.

last_name String · max 50

The surname associated with this address.

company String · max 50

The company associated with this address.

address1 String · Required · max 100

The first line of the street address.

address2 String · max 100

The second line of the street address.

city String · max 50

The city of this address.

region String · max 50

The two character code for states in the United States. Other countries may call this a province. When a two character code isn't available, use the full region name.

2 characters if code exists, otherwise.

postal_code String · max 50

The postal code of this address.

country String

The country code of this address.

Two character ISO 3166-1-alpha-2 code.

phone String · max 50

The phone of this address.

is_default_billing Boolean · Read-only

Specifies if this address is the default billing address for the customer.

is_default_shipping Boolean · Read-only

Specifies if this address is the default shipping address for the customer.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (3)

self This Customer Address
fx:store GET PATCH PUT DELETE This Store
fx:customer GET PATCH PUT DELETE This Customer
https://api.foxycart.com/customer_addresses/{id}
Available via fx:customer_address on billing_address·fx:customer_address on shipment

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/customer_addresses/123",
      "title": "This Customer Address"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:customer": {
      "href": "https://api.foxycart.com/customers/789",
      "title": "This Customer"
    }
  },
  "address_name": "awesome",
  "first_name": "firstname",
  "last_name": "lastname",
  "company": "My company",
  "address1": "12345 Any Street",
  "address2": "",
  "city": "Any City",
  "region": "TN",
  "postal_code": "37211",
  "country": "US",
  "phone": "",
  "is_default_billing": false,
  "is_default_shipping": false,
  "date_created": "2013-08-16T14:53:46-0700",
  "date_modified": "2013-08-16T14:53:46-0700"
}