Auth
- POSTAnonymous user
- POSTLogin with phone
- POSTLogin with email
- POSTLogin with whatsapp
- POSTLogin with password
- POSTVerify OTP
- POSTRegister with phone
- POSTRegister with email
- POSTRegister with whatsapp
- POSTRegister with password
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate OTP
- POSTLogout user
- POSTCheck email/phone verification status
Catalog
Carts
- POSTCreate cart
- GETRetrieve cart detail
- DELDelete cart
- GETRetrieve cart using user id
- DELDelete cart using user id
- POSTAdd/delete cart item
- POSTUpdate cart address
- POSTApply coupon
- DELRemove coupon
- POSTRedeem loyalty points
- DELRemove loyalty points
- POSTUse credit balance
- DELRemove credit balance
- POSTRedeem gift card
- DELRemove gift card
- GETRetrieve wishlist
- POSTAdd product to wishlist
- DELDelete product from wishlist
Coupons & promotions
Customers
Orders
Shipping
Analytics
Campaigns
Customers
Create customer
Customers
Create customer
Create customer
POST
/
customers
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"business": {
"business_type": "<string>",
"name": "<string>",
"pan_number": "<string>",
"gstin": "<string>"
},
"address": {
"id": "<string>",
"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": "123456789",
"business_name": "<string>"
}
}'
{
"message": "<string>",
"success": true,
"content": {
"customer_detail": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"is_phone_verified": true,
"is_email_verified": true,
"business": {
"business_type": "<string>",
"name": "<string>",
"pan_number": "<string>",
"gstin": "<string>"
}
}
}
}
Authorizations
Access token
Body
application/json
null value for guest checkout.
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
Allowed value:
"India"
Tax Identification Number (TIN/VAT/GSTIN) specific to the country of operation.
Example:
"123456789"
Use in billing & shipping details only.
Response
200
application/json
OK
Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.
10 digit phone number without country code.
curl --request POST \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/customers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"business": {
"business_type": "<string>",
"name": "<string>",
"pan_number": "<string>",
"gstin": "<string>"
},
"address": {
"id": "<string>",
"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": "123456789",
"business_name": "<string>"
}
}'
{
"message": "<string>",
"success": true,
"content": {
"customer_detail": {
"id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"country_code": "<string>",
"phone": "<string>",
"email": "<string>",
"is_phone_verified": true,
"is_email_verified": true,
"business": {
"business_type": "<string>",
"name": "<string>",
"pan_number": "<string>",
"gstin": "<string>"
}
}
}
}