List the company address book

const options = {
  method: 'GET',
  headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('http://{defaultHost}/api/v3/store/companies/{company_id}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "addr_EfhxLZ9ck8",
      "label": "Headquarters",
      "first_name": null,
      "last_name": null,
      "full_name": "",
      "address1": "410 Lovely Street",
      "address2": "Northwest",
      "postal_code": "10118",
      "city": "New York",
      "phone": "555-555-0199",
      "company": "Company",
      "country_name": "United States",
      "country_code": "US",
      "state_text": "NY",
      "state_code": "NY",
      "quick_checkout": false,
      "is_default_billing": false,
      "is_default_shipping": false,
      "state_abbr": "NY",
      "country_iso": "US",
      "state_name": "New York"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

GET

api

store

companies

{company_id}

addresses

List the company address book

const options = {
  method: 'GET',
  headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('http://{defaultHost}/api/v3/store/companies/{company_id}/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "id": "addr_EfhxLZ9ck8",
      "label": "Headquarters",
      "first_name": null,
      "last_name": null,
      "full_name": "",
      "address1": "410 Lovely Street",
      "address2": "Northwest",
      "postal_code": "10118",
      "city": "New York",
      "phone": "555-555-0199",
      "company": "Company",
      "country_name": "United States",
      "country_code": "US",
      "state_text": "NY",
      "state_code": "NY",
      "quick_checkout": false,
      "is_default_billing": false,
      "is_default_shipping": false,
      "state_abbr": "NY",
      "country_iso": "US",
      "state_name": "New York"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 1,
    "pages": 1,
    "from": 1,
    "to": 1,
    "in": 1,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[address1_cont]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`address1`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`address2`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`city`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`company`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`country_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`first_name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`last_name`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`phone`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`postal_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`state_code`	Text	`eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`

Sort by: address1, address2, city, company, country_code, created_at, first_name, id, last_name, phone, postal_code, state_code, updated_at. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Authorization

string

header

required

JWT token for authenticated customers

Headers

x-spree-api-key

string

required

Authorization

string

required

Path Parameters

company_id

string

required

Company node ID (comp_...)

Query Parameters

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

Response

200 - application/json

addresses listed

⌘I

API basics

Endpoints

List the company address book

Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Filters

Authorizations

Headers

Path Parameters

Query Parameters

Response

Filters