Skip to main content
POST
/
pos
/
auth
/
login
/
phone
Login with phone
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/pos/auth/login/phone \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "location_id": "<string>",
  "phone": "<string>",
  "country_code": "+91"
}'
{
  "message": "<string>",
  "success": true,
  "content": {
    "otp_token": "<string>",
    "otp_action": "<string>"
  }
}

Authorizations

X-Api-Key
string
header
required

API key for your store

Headers

x-debug-mode
boolean

This param is used to enable debug mode. If debug mode is enabled, the API will return OTP as well. This is only for development and testing purposes.

Body

application/json
location_id
string
required
phone
string
required

10 digit phone number without country code.

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.

Response

OK

message
string
required
success
boolean
required
content
object
required
โŒ˜I