Customer

Register a new customer

Register a new customer account

post/customers

Request

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Request body

firstNamestring required
lastNamestring required
emailstring email required
passwordstring password required
confirmPasswordstring password required
phonestring
gender'Male' | 'Female' | 'Other'
dateOfBirthstring date
statusinteger

Customer status (1 = active, 0 = inactive)

isVerifiedinteger

Whether the customer is verified (1 = verified, 0 = not verified)

isSuspendedinteger

Whether the customer is suspended (1 = suspended, 0 = active)

subscribedToNewsLetterboolean
deviceTokenstring

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "password": "Password123!",
  "confirmPassword": "Password123!",
  "phone": "1234567890",
  "dateOfBirth": "1990-01-15",
  "status": 1,
  "isVerified": 1,
  "subscribedToNewsLetter": true,
  "deviceToken": "your-fcm-device-token"
}

Response

Customer registered. token is the Bearer token for subsequent calls.

Changes

No recorded changes to this operation across all 13 revisions of this API.