Skip to main content
POST
Spree SDK

Authorizations

x-spree-api-key
string
header
required

Publishable API key for store access

Headers

x-spree-api-key
string
required

Body

application/json
email
string<email>
required
Example:

"newuser@example.com"

password
string
required
Example:

"password123"

password_confirmation
string
Example:

"password123"

first_name
string
Example:

"John"

last_name
string
Example:

"Doe"

phone
string
Example:

"+1 555 123 4567"

accepts_email_marketing
boolean
metadata
object

Write-only key-value metadata.

terms_of_service
boolean

Whether the customer ticked the storefront's terms of service box. Recorded as their consent.

Response

registration successful

token
string
required

JWT access token

refresh_token
string
required

Refresh token for obtaining new access tokens

user
object
required