Skip to main content
PATCH
/
api
/
v3
/
store
/
customers
/
me
Spree SDK
import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const customer = await client.customer.update({
  first_name: 'John',
  last_name: 'Doe',
  metadata: { preferred_contact: 'email' },
}, {
  token: '<token>',
})
{
  "id": "cus_UkLWZg9DAJ",
  "email": "huey.morissette@johns.us",
  "first_name": "Updated",
  "last_name": "Name",
  "phone": "555-555-0199",
  "accepts_email_marketing": false,
  "full_name": "Updated Name",
  "available_store_credit_total": "0",
  "display_available_store_credit_total": "$0.00",
  "addresses": [
    {
      "id": "addr_gbHJdmfrXB",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "address1": "166 Lovely Street",
      "address2": "Northwest",
      "postal_code": "10118",
      "city": "New York",
      "phone": "555-555-0199",
      "company": "Company",
      "country_name": "United States of America",
      "country_iso": "US",
      "state_text": "NY",
      "state_abbr": "NY",
      "quick_checkout": false,
      "is_default_billing": true,
      "is_default_shipping": false,
      "state_name": "New York"
    },
    {
      "id": "addr_UkLWZg9DAJ",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "address1": "165 Lovely Street",
      "address2": "Northwest",
      "postal_code": "10118",
      "city": "New York",
      "phone": "555-555-0199",
      "company": "Company",
      "country_name": "United States of America",
      "country_iso": "US",
      "state_text": "NY",
      "state_abbr": "NY",
      "quick_checkout": false,
      "is_default_billing": false,
      "is_default_shipping": true,
      "state_name": "New York"
    }
  ],
  "default_billing_address": {
    "id": "addr_gbHJdmfrXB",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "address1": "166 Lovely Street",
    "address2": "Northwest",
    "postal_code": "10118",
    "city": "New York",
    "phone": "555-555-0199",
    "company": "Company",
    "country_name": "United States of America",
    "country_iso": "US",
    "state_text": "NY",
    "state_abbr": "NY",
    "quick_checkout": false,
    "is_default_billing": true,
    "is_default_shipping": false,
    "state_name": "New York"
  },
  "default_shipping_address": {
    "id": "addr_UkLWZg9DAJ",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "address1": "165 Lovely Street",
    "address2": "Northwest",
    "postal_code": "10118",
    "city": "New York",
    "phone": "555-555-0199",
    "company": "Company",
    "country_name": "United States of America",
    "country_iso": "US",
    "state_text": "NY",
    "state_abbr": "NY",
    "quick_checkout": false,
    "is_default_billing": false,
    "is_default_shipping": true,
    "state_name": "New York"
  }
}

Documentation Index

Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-spree-api-key
string
header
required

Publishable API key for store access

​
Authorization
string
header
required

JWT token for authenticated customers

Headers

​
x-spree-api-key
string
required
​
Authorization
string
required

Body

application/json
​
first_name
string
Example:

"John"

​
last_name
string
Example:

"Doe"

​
email
string<email>
Example:

"customer@example.com"

​
password
string
Example:

"newpassword123"

​
password_confirmation
string
Example:

"newpassword123"

​
accepts_email_marketing
boolean
Example:

true

​
phone
string
Example:

"+1 555 123 4567"

​
metadata
object
Example:
{ "preferred_contact": "email" }

Response

profile updated

​
id
string
required
​
email
string
required
​
first_name
string | null
required
​
last_name
string | null
required
​
phone
string | null
required
​
accepts_email_marketing
boolean
required
​
full_name
string
required
​
available_store_credit_total
string
required
​
display_available_store_credit_total
string
required
​
addresses
object[]
required
​
default_billing_address
object
required
​
default_shipping_address
object
required