Storefront APIAccount
Sign a customer in
Exchanges e-mail and password for a customer session token.
Path Parameters
store_slug*string
Store slug
Header Parameters
Idempotency-Key?string
A unique value (e.g. a UUID) per logical request. Retrying with the same key within 24 hours replays the first response instead of repeating the side effect; the replay carries Idempotent-Replayed: true. Reusing a key for a different request is a 422 idempotency_key_reused; retrying while the first is still running is a 409 idempotency_request_in_progress. JSON bodies up to 1 MB.
Length
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/storefront-api/string/customers/login" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "password": "string" }'{
"customer": {
"created_at": "2019-08-24T14:15:22Z",
"email": "string",
"full_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"phone": "string"
},
"token": "string"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}{
"code": "not_found",
"details": {},
"error": "Order not found"
}