API Documentation
Authentication APIs
- Login & Register
- Create & Manage Users
- GETRetrieve a user
- PUTUpdate a user
- GETRetrieve a profile image
- PUTUpdate profile image
- POSTAdd profile image
- DELDelete profile image
- PUTDeactivate account
- GETRetrieve user notification preferences
- PUTUpdate user notification preferences
- POSTCreate user notification preferences
- POSTGenerate otp
- POSTCheck verified email phone
- GET
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
Create user notification preferences
curl --request POST \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/auth/user/{id}/notification-preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"notification_preferences": {
"transactional": {
"email": true,
"sms": true,
"whatsapp": true
},
"promotional": {
"email": true,
"sms": true,
"whatsapp": true
},
"newsletter": {
"email": true,
"sms": true,
"whatsapp": true
}
}
}'{
"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
Body
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.
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 POST \
--url https://services.commercengine.dev/api/v1/x2yh61zw4k/storefront/auth/user/{id}/notification-preferences \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"notification_preferences": {
"transactional": {
"email": true,
"sms": true,
"whatsapp": true
},
"promotional": {
"email": true,
"sms": true,
"whatsapp": true
},
"newsletter": {
"email": true,
"sms": true,
"whatsapp": true
}
}
}'{
"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
}
}
}
}