Register a customer with email and password
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/auth/register';const options = { method: 'POST', headers: { 'x-storefront-api-key': '<x-storefront-api-key>', 'Content-Type': 'application/json' }, body: '{"email":"shopper@example.com","password":"s3cret-password","name":"Nguyễn Văn A","anonymous_identity_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://apibase.ecomweb.app/api/v1/public/stores/example/auth/register \ --header 'Content-Type: application/json' \ --header 'x-storefront-api-key: <x-storefront-api-key>' \ --data '{ "email": "shopper@example.com", "password": "s3cret-password", "name": "Nguyễn Văn A", "anonymous_identity_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Creates an account with an email and password and, when the store requires it, emails a verification link. It never signs the shopper in: the answer has no tokens and is the same whether or not the email already had an account, so it cannot be used to find out which emails are registered. Keep verification_binding and send it with the emailed token to the verify-email route. An anonymous session can be upgraded in place with anonymous_identity_id. Rate limited to 5 requests per minute per store and client IP.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Example
shopper@example.comExample
s3cret-passwordExample
Nguyễn Văn AIdentity of an anonymous session to upgrade in place, so its cart and orders survive signup. Ignored unless it is anonymous, undeleted, and belongs to this store.
Responses
Section titled “Responses”object
Always null: registering does not sign the shopper in.
Always null: registering does not sign the shopper in.
Always null: the response does not reveal whether the account exists.
object
Identity ID (a UUID). Use it as the shopper’s sign-in ID.
Email address, or null for an anonymous session.
Whether the shopper has proved they own the email address.
True for a session issued by the anonymous route, which has no email or password.
Seconds an access token issued by this store stays valid.
A value to keep on the client and send as binding to the verify-email route, which ties the emailed link to the browser that registered. It is never emailed.
Example generated
{ "access_token": "example", "refresh_token": "example", "identity": { "id": "example", "email": "example", "email_verified": true, "is_anonymous": true }, "expires_in": 1, "verification_binding": "example"}The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}Too many requests; wait a little before retrying.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}