Retrieve an Account - Spree Commerce documentation

GET

api

storefront

account

Retrieve an Account

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://demo.spreecommerce.org/api/v2/storefront/account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

{
  "data": {
    "id": "1",
    "type": "user",
    "attributes": {
      "email": "spree@example.com",
      "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 Success - Returns the user object.

data

User · object

required

Show child attributes

included

Address · object[]

Show child attributes

Authentication

Create an Account

⌘I

Retrieve an Account

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://demo.spreecommerce.org/api/v2/storefront/account', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

{
  "data": {
    "id": "1",
    "type": "user",
    "attributes": {
      "email": "spree@example.com",
      "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"
        }
      }
    }
  }
}