Retrieve an Account

Retrieve an 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": "Doe",
      "selected_locale": "fr",
      "store_credits": 150.75,
      "completed_orders": 3,
      "tags": [
        "<string>"
      ],
      "public_metadata": {
        "user_segment": "supplier"
      }
    },
    "relationships": {
      "default_billing_address": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      },
      "default_shipping_address": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "address",
      "attributes": {
        "firstname": "John",
        "lastname": "Doe",
        "address1": "1600 Amphitheatre Pkwy",
        "address2": "Suite 1",
        "city": "Mountain View",
        "zipcode": "94043",
        "phone": "(+1) 123 456 789",
        "state_name": "California",
        "state_code": "CA",
        "country_name": "United States of America",
        "country_iso3": "USA",
        "company": "Google Inc.",
        "label": "Home"
      }
    }
  ]
}

GET

api

storefront

account

Retrieve an 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": "Doe",
      "selected_locale": "fr",
      "store_credits": 150.75,
      "completed_orders": 3,
      "tags": [
        "<string>"
      ],
      "public_metadata": {
        "user_segment": "supplier"
      }
    },
    "relationships": {
      "default_billing_address": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      },
      "default_shipping_address": {
        "data": {
          "id": "<string>",
          "type": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "1",
      "type": "address",
      "attributes": {
        "firstname": "John",
        "lastname": "Doe",
        "address1": "1600 Amphitheatre Pkwy",
        "address2": "Suite 1",
        "city": "Mountain View",
        "zipcode": "94043",
        "phone": "(+1) 123 456 789",
        "state_name": "California",
        "state_code": "CA",
        "country_name": "United States of America",
        "country_iso3": "USA",
        "company": "Google Inc.",
        "label": "Home"
      }
    }
  ]
}

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

data.id

string

required

Example:

"1"

data.type

string

default:user

required

data.attributes

object

required

Show child attributes

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

Show child attributes

data.relationships.default_billing_address

object

Default billing address associated with this Account

Show child attributes

data.relationships.default_billing_address.data

object

Show child attributes

data.relationships.default_billing_address.data.id

string

required

data.relationships.default_billing_address.data.type

string

required

data.relationships.default_shipping_address

object

Default shipping address associated with this Account

Show child attributes

data.relationships.default_shipping_address.data

object

Show child attributes

data.relationships.default_shipping_address.data.id

string

required

data.relationships.default_shipping_address.data.type

string

required

included

Address · object[]

Show child attributes

included.id

string

required

Example:

"1"

included.type

string

default:address

required

included.attributes

object

required

Show child attributes

included.attributes.firstname

string

Example:

"John"

included.attributes.lastname

string

Example:

"Doe"

included.attributes.address1

string

Example:

"1600 Amphitheatre Pkwy"

included.attributes.address2

string | null

Example:

"Suite 1"

included.attributes.city

string

Example:

"Mountain View"

included.attributes.zipcode

string

Example:

"94043"

included.attributes.phone

string | null

Example:

"(+1) 123 456 789"

included.attributes.state_name

string

Example:

"California"

included.attributes.state_code

string | null

State abbreviation

Example:

"CA"

included.attributes.country_name

string

Example:

"United States of America"

included.attributes.country_iso3

string

Country ISO3 code

Example:

"USA"

included.attributes.company

string | null

Company name

Example:

"Google Inc."

included.attributes.label

string | null

The internal name for this address (Work, Home)

Example:

"Home"

Authentication

Create an Account

⌘I

API basics

Tutorials

Storefront API

Platform API

Authorizations

Query Parameters

Response