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": "df999935272a603aa10f3e9e",
            "jwt": "example",
            "expires": 1773566312794
        },
        "sessionsCount": 42,
        "checkout": {
            "_id": "591678aa797ade0fea22fece",
            "id": "yvd-Q0C3D",
            "configRef": "efcfb4c0e82c37fe3ee651b4",
            "origin": "example",
            "created": 1721440694538,
            "orderId": "example",
            "updated": 1755829488182,
            "expires": 1716716860810,
            "status": "example",
            "message": "example",
            "useSingleAddress": true
        }
    }
}

Arguments

Name	Type	Description
email	String!	User's email address.
password	String!	User's password.
checkoutId	String	Optional checkout identifier to associate with the session.

Returns

LoginResponse