Skip to main content

Version: v1

Login User

Authenticate a user by verifying their email and password credentials. Upon successful authentication, returns user details and an access token for authorized requests.

HTTP Method & Endpoint​

POST | /auth/login

Request​

Request Body Parameters​

ParameterTypeRequiredDescription
emailStringYesUser's registered email address
passwordStringYesUser's password
storeIdStringYesStoreId (should match x-store-id header)

Response Format​

Success Response (200 OK)​

FieldTypeDescription
messageStringStatus message indicating successful login
dataDataContains user details and authentication token
sourceStringSource of the data (e.g., "db")

Data Object Properties​

FieldTypeDescription
customerCustomerContains all details about the authenticated user
accessTokenStringJWT token for authenticated requests
isVerifiedBooleanIndicates if user's email is verified

Customer Object Properties​

FieldTypeDescription
idStringUnique identifier for the user
storeIdStringStore ID the user belongs to
emailStringUser's email address
mobileNumberStringUser's mobile number (if available)
emailVerifiedStringTimestamp of email verification
mobileVerifiedStringTimestamp of mobile verification
statusStringAccount status (e.g., "ACTIVE")
createdAtStringAccount creation timestamp
updatedAtStringLast account update timestamp

Sample Success Response​

{
  "message": "Login Success",
  "data": {
    "customer": {
      "id": "2342341293912313",
      "storeId": "2342341293912313",
      "email": "abc@gmail.com",
      "mobileNumber": null,
      "emailVerified": "2025-05-16T06:26:16.513Z",
      "mobileVerified": null,
      "status": "ACTIVE",
      "createdAt": "2025-05-16T06:25:36.043Z",
      "updatedAt": "2025-05-16T06:26:16.514Z"
    },
    "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCI....",
    "isVerified": true
  },
  "source": "db"
}

Examples​

important

Make sure to store the customerId after login, as it will be required later to fetch the customer's cart .

JavaScript (React)​

import axios from "axios";
import { api, STORE_ID } from "../constant";

const loginUser = async () => {
  try {
    const response = await api.post("/auth/login", {
      email: "abc@gmail.com",
      password: "12312312",
      storeId: STORE_ID,
    });

    console.log("Login successful:", response.data);
    const data = response.data.data;
    const customer = data?.customer;
    if (customer && customer.id) {
      localStorage.setItem("customerId", customer.id); // Store customerId for future use
    }
  } catch (error) {
    console.error("Login failed:", error.response?.data || error.message);
  }
};

Error Responses​

Status CodeDescription
400Bad Request - Invalid parameters or validation failed
401Unauthorized - Invalid email or password
403Forbidden - Account inactive or suspended
404Not Found - Email address not registered
500Internal Server Error - Something went wrong on the server

Sample Error Responses​

Invalid Credentials:

{
  "requestId": "a3ffb59a-7f6a-4d48-96c3-485931bcb6b9",
  "error": "UnauthorizedException",
  "statusCode": 401,
  "message": "Invalid Password for abc@gmail.com.",
  "path": "/auth/login",
  "timestamp": 1748352877808
}