Update an Address

Update an Address

curl --request PATCH \
  --url https://demo.spreecommerce.org/api/v2/storefront/account/addresses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "address": {
    "firstname": "Stephen",
    "lastname": "Smith",
    "company": "Woodbank School",
    "address1": "234 Old Georgetown Road",
    "address2": "1st Floor",
    "city": "Aethesda",
    "phone": "34885493845002",
    "zipcode": "90211",
    "state_name": "CA",
    "country_iso": "US",
    "label": "Office"
  }
}
'

{
  "data": {
    "id": "29",
    "type": "address",
    "attributes": {
      "firstname": "Mark",
      "lastname": "Winterburn",
      "address1": "775645 Old Georgetown Road",
      "address2": "3rd Floor",
      "city": "Qethesda",
      "zipcode": "90210",
      "phone": "3488545445002",
      "state_name": "California",
      "company": "Paper Street Soap Co.",
      "country_name": "United States",
      "country_iso3": "USA",
      "country_iso": "US",
      "label": "Work",
      "state_code": "CA"
    }
  }
}

PATCH

api

storefront

account

addresses

{id}

Update an Address

curl --request PATCH \
  --url https://demo.spreecommerce.org/api/v2/storefront/account/addresses/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "address": {
    "firstname": "Stephen",
    "lastname": "Smith",
    "company": "Woodbank School",
    "address1": "234 Old Georgetown Road",
    "address2": "1st Floor",
    "city": "Aethesda",
    "phone": "34885493845002",
    "zipcode": "90211",
    "state_name": "CA",
    "country_iso": "US",
    "label": "Office"
  }
}
'

{
  "data": {
    "id": "29",
    "type": "address",
    "attributes": {
      "firstname": "Mark",
      "lastname": "Winterburn",
      "address1": "775645 Old Georgetown Road",
      "address2": "3rd Floor",
      "city": "Qethesda",
      "zipcode": "90210",
      "phone": "3488545445002",
      "state_name": "California",
      "company": "Paper Street Soap Co.",
      "country_name": "United States",
      "country_iso3": "USA",
      "country_iso": "US",
      "label": "Work",
      "state_code": "CA"
    }
  }
}

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Path Parameters

string

required

The ID of the specified address.

Example:

"1"

Query Parameters

fields[address]

string

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

Body

application/vnd.api+json

address

object

Show child attributes

address.firstname

string

required

address.lastname

string

required

address.address1

string

required

Street address

address.city

string

required

City, town

address.country_iso

string

required

Country ISO (2-chars) or ISO3 (3-chars) code. List of all codes

address.address2

string

Additional address information, floor no etc

address.phone

string

address.zipcode

string

Valid zipcode, will be validated against the selected Country

address.state_name

string

State/region/province 2 letter abbreviation

address.company

string

Company name

Example:

"Paper Street Soap Co."

address.label

string

The internal name for this address (Work, Home)

Example:

"Work"

Example:

{
  "firstname": "John",
  "lastname": "Snow",
  "address1": "7735 Old Georgetown Road",
  "address2": "2nd Floor",
  "city": "Bethesda",
  "phone": "3014445002",
  "zipcode": "20814",
  "state_name": "MD",
  "country_iso": "US"
}

Response

200 Success - Returns the address object.

data

Address · object

The Address model holds the customer details, such as name, address, and phone number.

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"

Remove an Address

List all Credit Cards

⌘I

API basics

Tutorials

Storefront API

Platform API

Authorizations

Path Parameters

Query Parameters

Body

Response