API Documentation
Authentication APIs
- Login & Register
- GETAnonymous 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
- POSTLogout user
- POSTRefresh access token
- POSTChange password
- POSTForgot password
- POSTReset password
- GET
- Create & Manage Users
Catalog APIs
- GETList all products
- GETList all skus
- GETRetrieve a product
- GETRetrieve product variants
- GETRetrieve variant detail
- GETList all categories
- GETRetrieve product reviews
- POSTCreate product review
- GETRetrieve similar products
- GETRetrieve up sell products
- GETRetrieve cross sell products
- GETRetrieve recommended products
- POSTDatocms webhook
Cart & Checkout APIs
- Cart
- Checkout
Coupons & promotions API
Customers API
Orders APIs
Shipping APIs
Analytics
Campaigns API
Logout user
curl --request POST \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/auth/logout \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"access_token": "<string>",
"refresh_token": "<string>",
"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>",
"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>",
"is_anonymous": true,
"is_logged_in": true,
"login_methods": [
"<string>"
]
}
}
}Authorizations
Access token
Response
A descriptive message confirming the success or failure of the operation.
Indicates whether the request was successful or failure (true for success, false for failure).
An object containing the response content.
It is a string-based token utilized for authentication and authorization.
It is a string-based token designed for refreshing the user's access token.
An object representing user details.
The unique identifier (ULID) of the user.
User’s first name.
User’s last name.
User’s email I’d.
Boolean indicating whether the email is verified.
10 digit phone number without country code.
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.
Boolean indicating whether the phone is verified.
URL to the user's profile image.
User's notification preferences are categorized by transactional, promotional, and newsletter types.
These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities.
Indicates whether the user has opted to receive notifications via email.
Indicates whether the user has opted to receive notifications via SMS.
Indicates whether the user has opted to receive notifications via WhatsApp.
These notifications aim to engage users with promotional content and enhance their overall experience with the platform.
Indicates whether the user has opted to receive notifications via email.
Indicates whether the user has opted to receive notifications via SMS.
Indicates whether the user has opted to receive notifications via WhatsApp.
These notifications are often sent periodically as part of a subscription service.
Indicates whether the user has opted to receive notifications via email.
Indicates whether the user has opted to receive notifications via SMS.
Indicates whether the user has opted to receive notifications via WhatsApp.
Timestamps indicate when the user's account was created.
Timestamps indicating when the user account was last modified.
Indicates whether the user is anonymous.
Indicates whether the user is currently logged in.
curl --request POST \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/auth/logout \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"access_token": "<string>",
"refresh_token": "<string>",
"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>",
"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>",
"is_anonymous": true,
"is_logged_in": true,
"login_methods": [
"<string>"
]
}
}
}