Create an Address - Spree Commerce documentation

Community

Github

API basics

Storefront API

Authentication
Account
Account / Address
- GET
  List all Addresses
- POST
  Create an Address
- DEL
  Remove an Address
- PATCH
  Update an Address
Account / Credit Cards
Account / Orders
Order Status
Cart
Cart / Line Items
Cart / Other
Cart / Coupons
Checkout
Checkout / State
Checkout / Shipments
Checkout / Payments
Checkout / Store Credit
Stripe
Products
Vendors
Stores
Taxons
Countries
CMS Pages
Menus
Wishlists
Wishlists / Wished Items
Digital Downloads

Platform API

Authentication
Addresses
Adjustments
Classifications
CMS Pages
CMS Sections
Countries
Data Feeds
Digital Links
Digital Assets
Line Items
Menu Items
Menus
Option Types
Option Values
Orders
Payment Methods
Payments
Products
Promotion Actions
Promotion Categories
Promotion Rules
Promotions
Roles
Shipments
Shipping Categories
Shipping Methods
States
Stock Items
Stock Locations
Store Credit Categories
Store Credit Types
Store Credits
Tax Categories
Tax Rates
Taxonomies
Taxons
Users
Variants
Vendors
Webhook Events
Webhook Subscribers
Wished Items
Wishlists
Zones

POST

api

storefront

account

addresses

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"
    }
  }
}

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.

Body

application/vnd.api+json

address

object

Response

200

application/vnd.api+json

200 Success - Returns the `address` object.

data

object

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

Was this page helpful?

Suggest edits Raise issue

List all Addresses Remove an Address

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"
    }
  }
}