Skip to content

Sign in with email and password

POST
/public/stores/{storeRef}/auth/login
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.

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
email
required
string
<= 255 characters

Example

shopper@example.com
password
required
string
<= 128 characters

Example

s3cret-password
Media typeapplication/json
object
identity
required

The signed-in identity.

object
id
required

Identity ID (a UUID). Use it as the shopper’s sign-in ID.

string
email
required

Email address, or null for an anonymous session.

string
nullable
email_verified
required

Whether the shopper has proved they own the email address.

boolean
is_anonymous
required

True for a session issued by the anonymous route, which has no email or password.

boolean
access_token
required

The access token, a signed JWT. Send it as Authorization: Bearer <access_token> (the customerToken scheme).

string
refresh_token
required

The refresh token, 64 hex characters. Single-use: each refresh returns a new one and revokes this one.

string
expires_in
required

Seconds until the access token expires. The store sets this; the default is 15 minutes.

number

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

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.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The account is temporarily locked after repeated failed attempts.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

Too many requests; wait a little before retrying.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}