POST
/
auth
/
register
/
phone
Register with phone
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/register/phone \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "<string>",
  "phone": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<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
string
required

10 digit phone number without country code.

first_name
string
required

A string representing the first name.

country_code
string | null

Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.

Allowed value: "+91"
last_name
string | null

A string representing the last name.

email
string | null

A string representing the email address.

Response

OK

message
string
required

A descriptive message confirming the success or failure of the Registration 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.