Skip to main content
POST
/
auth
/
register
/
email
Register with email
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/register/email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "first_name": "<string>",
  "last_name": "<string>",
  "phone": "<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
        }
      },
      "customer_id": "<string>",
      "customer_group": {
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "description": "<string>",
        "is_default": true,
        "active": true
      },
      "business": {
        "type": "<string>",
        "name": "<string>",
        "metadata": {},
        "registered_address": {
          "first_name": "<string>",
          "last_name": "<string>",
          "country_code": "<string>",
          "phone": "<string>",
          "email": "<string>",
          "address_line1": "<string>",
          "address_line2": "<string>",
          "landmark": "<string>",
          "pincode": "<string>",
          "city": "<string>",
          "state": "<string>",
          "country": "<string>",
          "tax_identification_number": "<string>",
          "business_name": "<string>",
          "is_phone_verified": true,
          "is_email_verified": true,
          "id": "<string>",
          "is_default_billing": true,
          "is_default_shipping": true,
          "nickname": null
        }
      },
      "created_at": "<string>",
      "modified_at": "<string>"
    },
    "access_token": "<string>",
    "refresh_token": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Access token

Body

application/json
email
string<email>
required
first_name
string
required
last_name
string | null
phone
string | null

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.