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
Retrieve user notification preferences
The Retrieve Notification Preferences API allows clients to fetch a user’s notification preferences based on their unique user identifier (user_id).
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/user/{id}/notification-preferences \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"notification_preferences": {
"transactional": {
"email": true,
"sms": true,
"whatsapp": true
},
"promotional": {
"email": true,
"sms": true,
"whatsapp": true
},
"newsletter": {
"email": true,
"sms": true,
"whatsapp": true
}
}
}
}Authorizations
Access token
Path Parameters
user id
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.
An object containing the user's notification preferences.
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.
curl --request GET \
--url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/user/{id}/notification-preferences \
--header 'Authorization: Bearer <token>'{
"message": "<string>",
"success": true,
"content": {
"notification_preferences": {
"transactional": {
"email": true,
"sms": true,
"whatsapp": true
},
"promotional": {
"email": true,
"sms": true,
"whatsapp": true
},
"newsletter": {
"email": true,
"sms": true,
"whatsapp": true
}
}
}
}