Skip to main content
POST
/
auth
/
login
/
password
Login with password
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/login/password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "<string>",
  "country_code": "+91",
  "password": "<string>"
}'
{
  "message": "<string>",
  "success": true,
  "content": {
    "user": {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "is_email_verified": true,
      "phone": "<string>",
      "country_code": "<string>",
      "is_phone_verified": true,
      "profile_image_url": "<string>",
      "is_anonymous": true,
      "is_logged_in": true,
      "login_methods": [
        "email"
      ],
      "notification_preferences": {
        "transactional": {
          "email": true,
          "sms": true,
          "whatsapp": true
        },
        "promotional": {
          "email": true,
          "sms": true,
          "whatsapp": true
        },
        "newsletter": {
          "email": true,
          "sms": true,
          "whatsapp": true
        }
      },
      "created_at": "<string>",
      "modified_at": "<string>"
    },
    "access_token": "<string>",
    "refresh_token": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Access token

Body

application/json
  • phone
  • email
phone
string
required

User's phone number.

password
string
required

The password associated with the user's account.

country_code
string
default:+91

Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. Use this key along with phone. Not necessary for email.

Response

OK

message
string
required

A descriptive message confirming the success or failure of the Login process.

success
boolean
required

Indicates whether the request was successful or failure (true for success, false for failure).

content
object
required

An object containing the response content.

I