customer_addresses

Resource: customer_address

This link relationship returns a collection of customer addresses. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read customers_read
Write customers_write

Collection Resource

customer_address

Actions

GET View a list of customer_addresses
POST Create a new customer address
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (5)

_embedded Object · Read-only

Contains fx:customer_addresses[] — array of customer_address resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/customers/{customer_id}/addresses
Available via fx:customer_addresses on customer

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/customer_addresses",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/customer_addresses?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/customer_addresses?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/customer_addresses?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/customer_addresses?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:customer_addresses": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/customer_addresses/456",
            "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"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}