Skip to main content

login Mutation

Description

Authenticates a user with email and password.

mutation login($email: String!, $password: String!, $checkoutId: String) {
login(email: $email, password: $password, checkoutId: $checkoutId) {
session {
_id
jwt
expires
}
sessionsCount
checkout {
_id
id
configRef
origin
created
orderId
updated
expires
status
message
useSingleAddress
}
}
}

Variables

{
"email": "email@example.com",
"password": "password",
"checkoutId": "checkoutId"
}

Response

{
"login": {
"session": {
"_id": "2554ecc582bb2c126d144672",
"jwt": "example",
"expires": 1737446460514
},
"sessionsCount": 42,
"checkout": {
"_id": "a9727b1a325071ce26ac2a6c",
"id": "XoN-LmLKE",
"configRef": "dd010f91aa97f528f663ad42",
"origin": "example",
"created": 1738527854939,
"orderId": "example",
"updated": 1756990400040,
"expires": 1728714868364,
"status": "example",
"message": "example",
"useSingleAddress": true
}
}
}

Arguments

NameTypeDescription
emailString!User's email address.
passwordString!User's password.
checkoutIdStringOptional checkout identifier to associate with the session.

Returns

LoginResponse