Create an Account - Spree Commerce documentation

POST

api

storefront

account

Create an Account

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    user: {
      email: 'john@snow.org',
      first_name: 'John',
      last_name: 'Snow',
      selected_locale: 'en',
      password: 'spree123',
      password_confirmation: 'spree123',
      public_metadata: {user_segment: 'supplier'},
      private_metadata: {has_abandoned_cart: false}
    }
  })
};

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

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

Body

application/vnd.api+json

user

object

Show child attributes

Response

200 Success - Returns the user object.

data

User · object

required

Show child attributes

included

Address · object[]

Show child attributes

Retrieve an Account

Update an Account

⌘I

Create an Account

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    user: {
      email: 'john@snow.org',
      first_name: 'John',
      last_name: 'Snow',
      selected_locale: 'en',
      password: 'spree123',
      password_confirmation: 'spree123',
      public_metadata: {user_segment: 'supplier'},
      private_metadata: {has_abandoned_cart: false}
    }
  })
};

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

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