Sign in with email and password
const url = 'https://apibase.ecomweb.app/api/v1/public/stores/example/auth/login';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"}'};
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/login \ --header 'Content-Type: application/json' \ --header 'x-storefront-api-key: <x-storefront-api-key>' \ --data '{ "email": "shopper@example.com", "password": "s3cret-password" }'Checks the email and password and starts a session. Use access_token as the customerToken bearer token on shopper routes and refresh_token to get a new pair with the refresh route. Wrong credentials, an unknown email and an account with no password all return the same 401. After repeated failures the account is locked for a while and the route answers 423. 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-passwordResponses
Section titled “Responses”object
The signed-in identity.
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.
The access token, a signed JWT. Send it as Authorization: Bearer <access_token> (the customerToken scheme).
The refresh token, 64 hex characters. Single-use: each refresh returns a new one and revokes this one.
Seconds until the access token expires. The store sets this; the default is 15 minutes.
Example generated
{ "identity": { "id": "example", "email": "example", "email_verified": true, "is_anonymous": true }, "access_token": "example", "refresh_token": "example", "expires_in": 1}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"}The account is temporarily locked after repeated failed attempts.
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"}