Create an Address
Creates a new address for the current user.
POST
/
api
/
v2
/
storefront
/
account
/
addresses
Create an Address
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
address: {
firstname: 'Mark',
lastname: 'Winterburn',
company: 'Paper Street Soap Co.',
address1: '775 Old Georgetown Road',
address2: '3rd Floor',
city: 'Qethesda',
phone: '3488545445002',
zipcode: '90210',
state_name: 'CA',
country_iso: 'US',
label: 'Work'
}
})
};
fetch('https://demo.spreecommerce.org/api/v2/storefront/account/addresses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://demo.spreecommerce.org/api/v2/storefront/account/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"address": {
"firstname": "Mark",
"lastname": "Winterburn",
"company": "Paper Street Soap Co.",
"address1": "775 Old Georgetown Road",
"address2": "3rd Floor",
"city": "Qethesda",
"phone": "3488545445002",
"zipcode": "90210",
"state_name": "CA",
"country_iso": "US",
"label": "Work"
}
}
'{
"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"
}
}
}{
"error": "You are not authorized to access this page."
}Authorizations
User token to authorize Cart and Checkout requests.
It is required to associate Cart with the User.
Query Parameters
Specify the fields you would like returned in the response body. More information.
Body
application/vnd.api+json
Show child attributes
Show child attributes
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.
The Address model holds the customer details, such as name, address, and phone number.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Create an Address
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
address: {
firstname: 'Mark',
lastname: 'Winterburn',
company: 'Paper Street Soap Co.',
address1: '775 Old Georgetown Road',
address2: '3rd Floor',
city: 'Qethesda',
phone: '3488545445002',
zipcode: '90210',
state_name: 'CA',
country_iso: 'US',
label: 'Work'
}
})
};
fetch('https://demo.spreecommerce.org/api/v2/storefront/account/addresses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://demo.spreecommerce.org/api/v2/storefront/account/addresses \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/vnd.api+json' \
--data '
{
"address": {
"firstname": "Mark",
"lastname": "Winterburn",
"company": "Paper Street Soap Co.",
"address1": "775 Old Georgetown Road",
"address2": "3rd Floor",
"city": "Qethesda",
"phone": "3488545445002",
"zipcode": "90210",
"state_name": "CA",
"country_iso": "US",
"label": "Work"
}
}
'{
"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"
}
}
}{
"error": "You are not authorized to access this page."
}