Retrieve an Account - Spree Commerce documentation

Community

Github

API basics

Storefront API

Authentication
Account
- GET
  Retrieve an Account
- POST
  Create an Account
- PATCH
  Update an Account
Account / 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

GET

api

storefront

account

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

{
  "data": {
    "id": "1",
    "type": "user",
    "attributes": {
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Snow",
      "selected_locale": "en",
      "store_credits": 0,
      "completed_orders": 0,
      "tags": [
        "VIP",
        "supplier"
      ],
      "public_metadata": {
        "user_segment": "supplier"
      }
    },
    "relationships": {
      "default_billing_address": {
        "data": {
          "id": "2",
          "type": "address"
        }
      },
      "default_shipping_address": {
        "data": {
          "id": "1",
          "type": "address"
        }
      }
    }
  }
}

Authorizations

Authorization

string

header

required

User token to authorize Cart and Checkout requests.

It is required to associate Cart with the User.

Query Parameters

include

string

Pass default_billing_address and/or default_shipping_address as value to include selected addresses information

fields[user]

string

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

Response

200

application/vnd.api+json

200 Success - Returns the `user` object.

data

object

required

data.id

string

required

Example:

"1"

data.type

string

default:user

required

data.attributes

object

required

data.attributes.email

string

Example:

"[email protected]"

data.attributes.first_name

string

Example:

"John"

data.attributes.last_name

string

Example:

"Doe"

data.attributes.selected_locale

string

Example:

"fr"

data.attributes.store_credits

number

Example:

150.75

data.attributes.completed_orders

number

Number of placed Orders by this User

Example:

3

data.attributes.tags

string[]

List of tags associated with the user

data.attributes.public_metadata

object

The public metadata for this User

Example:

{ "user_segment": "supplier" }

data.relationships

object

required

included

object[]

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

Was this page helpful?

Suggest edits Raise issue

Create an AccountCreates a new account

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

{
  "data": {
    "id": "1",
    "type": "user",
    "attributes": {
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Snow",
      "selected_locale": "en",
      "store_credits": 0,
      "completed_orders": 0,
      "tags": [
        "VIP",
        "supplier"
      ],
      "public_metadata": {
        "user_segment": "supplier"
      }
    },
    "relationships": {
      "default_billing_address": {
        "data": {
          "id": "2",
          "type": "address"
        }
      },
      "default_shipping_address": {
        "data": {
          "id": "1",
          "type": "address"
        }
      }
    }
  }
}