Auth

Register with password

The User Registration with Password API facilitates user onboarding by allowing registration through a combination of phone number and email. API collects essential registration details, including phone number, email, password and the confirmation of the chosen password. The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user’s information, access token and refresh token.

POST

auth

password

curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/register/password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "<string>",
  "phone": "<string>",
  "email": "[email protected]",
  "password": "<string>",
  "confirm_password": "<string>"
}'

{
  "message": "<string>",
  "success": true,
  "content": {
    "user": {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[email protected]",
      "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.

string

required

A string representing the email address.

password

string

required

A string representing the user's chosen password.

confirm_password

string

required

A string representing the confirmation of the chosen password.

country_code

string

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 only. Not necessary for email.

Response

200 - application/json

message

string

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

success

boolean

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

content

object

An object containing the response content.

content.user

object

An object representing user details.

content.user.id

string

required

The unique ID of the user.

content.user.first_name

string

required

User’s first name.

content.user.last_name

string

required

User’s last name.

content.user.email

string

required

User’s email I’d.

content.user.is_email_verified

boolean

required

Boolean indicating whether the email is verified.

content.user.phone

string

required

10 digit phone number without country code.

content.user.country_code

string

required

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.

content.user.is_phone_verified

boolean

required

Boolean indicating whether the phone is verified.

content.user.profile_image_url

string

required

URL to the user's profile image.

content.user.is_anonymous

boolean

required

Indicates whether the user is anonymous.

content.user.is_logged_in

boolean

required

Indicates whether the user is currently logged in.

Available options:

email,

phone,

whatsapp,

password

content.user.notification_preferences

object

required

User's notification preferences are categorized by transactional, promotional, and newsletter types.

content.user.created_at

string

Timestamps indicate when the user's account was created.

content.user.modified_at

string

Timestamps indicating when the user account was last modified.

content.access_token

string

It is a string-based token utilized for authentication and authorization.

content.refresh_token

string

It is a string-based token designed for refreshing the user's access token.

Retrieve a userThe Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.

curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/register/password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "country_code": "<string>",
  "phone": "<string>",
  "email": "[email protected]",
  "password": "<string>",
  "confirm_password": "<string>"
}'

{
  "message": "<string>",
  "success": true,
  "content": {
    "user": {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[email protected]",
      "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>"
  }
}

Auth

Catalog

Carts

Coupons & promotions

Customers

Orders

Shipping

PayU

Payments

Juspay

Common

Analytics

Campaigns

Subscriptions

Register with password

Authorizations

Body

Response