Create Customer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to create one customer account with its required identity, contact, and address information.

The request body requires first_name, last_name, email, username, address1, city, postal_code, country, and phone. The username must be 3–20 characters and contain only letters, numbers, underscores, or hyphens. Set send_email to control whether Storefront sends an email; it defaults to false.

If your bearer token can access more than one system login, send x-osrs-system-login-id to select the login to use; you can omit this header when exactly one login is available. A successful response returns the new customer's UUID. A 400 response can indicate incomplete onboarding or invalid country, state, postal-code, or currency data; 409 indicates that the username already exists; and 422 indicates a validation error.

Body Params
length between 1 and 255

External user ID

string
required
length between 1 and 50
^[^\x00-\x1F\x7F]+$
string
required
length between 1 and 50
^[^\x00-\x1F\x7F]+$
string
required
string
required
length between 3 and 20
^[a-zA-Z0-9_-]+$
string
required
length between 1 and 255
^[^\x00-\x1F\x7F]+$
string
required
length between 1 and 100
^[^\x00-\x1F\x7F]+$
string
required
length ≥ 1
^[^\x00-\x1F\x7F]+$
string
required
length between 2 and 2

2-letter ISO country code

length between 1 and 50
^[^\x00-\x1F\x7F]+$
string
required
length ≥ 1
boolean
Defaults to false
Headers

ID (id) of user's login to use for request. Optional if there is exactly one to choose from.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json