List all Addresses

List all Addresses

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/account/addresses \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "11",
      "type": "address",
      "attributes": {
        "firstname": "Tyler",
        "lastname": "Durden",
        "address1": "12312 Street",
        "address2": "Basment Entrance",
        "city": "LA",
        "zipcode": "90210",
        "phone": "08173762736",
        "state_name": "California",
        "company": "Paper Street Soap Co",
        "country_name": "United States",
        "country_iso3": "USA",
        "country_iso": "US",
        "label": "Home",
        "state_code": "CA"
      }
    },
    {
      "id": "28",
      "type": "address",
      "attributes": {
        "firstname": "John",
        "lastname": "Snow",
        "address1": "7735 Old Georgetown Road",
        "address2": "2nd Floor",
        "city": "Bethesda",
        "zipcode": "20814",
        "phone": "3014445002",
        "state_name": "Maryland",
        "company": null,
        "country_name": "United States",
        "country_iso3": "USA",
        "country_iso": "US",
        "label": null,
        "state_code": "MD"
      }
    },
    {
      "id": "29",
      "type": "address",
      "attributes": {
        "firstname": "Emma",
        "lastname": "Carragher",
        "address1": "775645 Old Georgetown Road",
        "address2": "3rd Floor",
        "city": "Qethesda",
        "zipcode": "90210",
        "phone": "3488545445002",
        "state_name": "California",
        "company": null,
        "country_name": "United States",
        "country_iso3": "USA",
        "country_iso": "US",
        "label": "Work",
        "state_code": "CA"
      }
    }
  ],
  "meta": {
    "count": 3,
    "total_count": 3,
    "total_pages": 1
  },
  "links": {
    "self": "http://localhost:3000/api/v2/storefront/account/addresses",
    "next": "http://localhost:3000/api/v2/storefront/account/addresses?page=1",
    "prev": "http://localhost:3000/api/v2/storefront/account/addresses?page=1",
    "last": "http://localhost:3000/api/v2/storefront/account/addresses?page=1",
    "first": "http://localhost:3000/api/v2/storefront/account/addresses?page=1"
  }
}

GET

api

storefront

account

addresses

List all Addresses

curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/account/addresses \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "11",
      "type": "address",
      "attributes": {
        "firstname": "Tyler",
        "lastname": "Durden",
        "address1": "12312 Street",
        "address2": "Basment Entrance",
        "city": "LA",
        "zipcode": "90210",
        "phone": "08173762736",
        "state_name": "California",
        "company": "Paper Street Soap Co",
        "country_name": "United States",
        "country_iso3": "USA",
        "country_iso": "US",
        "label": "Home",
        "state_code": "CA"
      }
    },
    {
      "id": "28",
      "type": "address",
      "attributes": {
        "firstname": "John",
        "lastname": "Snow",
        "address1": "7735 Old Georgetown Road",
        "address2": "2nd Floor",
        "city": "Bethesda",
        "zipcode": "20814",
        "phone": "3014445002",
        "state_name": "Maryland",
        "company": null,
        "country_name": "United States",
        "country_iso3": "USA",
        "country_iso": "US",
        "label": null,
        "state_code": "MD"
      }
    },
    {
      "id": "29",
      "type": "address",
      "attributes": {
        "firstname": "Emma",
        "lastname": "Carragher",
        "address1": "775645 Old Georgetown Road",
        "address2": "3rd Floor",
        "city": "Qethesda",
        "zipcode": "90210",
        "phone": "3488545445002",
        "state_name": "California",
        "company": null,
        "country_name": "United States",
        "country_iso3": "USA",
        "country_iso": "US",
        "label": "Work",
        "state_code": "CA"
      }
    }
  ],
  "meta": {
    "count": 3,
    "total_count": 3,
    "total_pages": 1
  },
  "links": {
    "self": "http://localhost:3000/api/v2/storefront/account/addresses",
    "next": "http://localhost:3000/api/v2/storefront/account/addresses?page=1",
    "prev": "http://localhost:3000/api/v2/storefront/account/addresses?page=1",
    "last": "http://localhost:3000/api/v2/storefront/account/addresses?page=1",
    "first": "http://localhost:3000/api/v2/storefront/account/addresses?page=1"
  }
}

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Query Parameters

fields[address]

string

Specify the fields you would like returned in the response body. More information.

filter[exclude_quick_checkout]

boolean

Exclude addresses that were created during quick checkout

Response

200 Success - Returns an array of address objects.

data

Address · object[]

required

Show child attributes

data.id

string

required

Example:

"1"

data.type

string

default:address

required

data.attributes

object

required

Show child attributes

data.attributes.firstname

string

Example:

"John"

data.attributes.lastname

string

Example:

"Doe"

data.attributes.address1

string

Example:

"1600 Amphitheatre Pkwy"

data.attributes.address2

string | null

Example:

"Suite 1"

data.attributes.city

string

Example:

"Mountain View"

data.attributes.zipcode

string

Example:

"94043"

data.attributes.phone

string | null

Example:

"(+1) 123 456 789"

data.attributes.state_name

string

Example:

"California"

data.attributes.state_code

string | null

State abbreviation

Example:

"CA"

data.attributes.country_name

string

Example:

"United States of America"

data.attributes.country_iso3

string

Country ISO3 code

Example:

"USA"

data.attributes.company

string | null

Company name

Example:

"Google Inc."

data.attributes.label

string | null

The internal name for this address (Work, Home)

Example:

"Home"

API basics

Tutorials

Storefront API

Platform API

Authorizations

Query Parameters

Response