For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
Storefront
Mutations
login
Copy page
Customer login.
Arguments
email
String
Required
An email of the customer.
password
String
Required
A password of the customer.
guestCartEntityId
String
Optional
The guest cart entity ID which should be assigned to customer.
Returns
a LoginResult
result
String
The result of a login
customer
Customer
The currently logged in customer.
cart
Cart
The cart that is assigned to the customer after login.
customerAccessToken
CustomerAccessToken
The customer access token. This field can only be fetched in server-to-server context.