Commerce Engine Docs home page

Return to site
Support
Return to site

Documentation

Storefront API Reference

Admin API Reference

Documentation

API Documentation

Introduction

Authentication APIs

Login & Register
Create & Manage Users

Catalog APIs

GET
List all products
GET
List all skus
GET
Retrieve a product
GET
Retrieve product variants
GET
Retrieve variant detail
GET
List all categories
GET
Retrieve product reviews
POST
Create product review
GET
Retrieve similar products
GET
Retrieve up sell products
GET
Retrieve cross sell products
GET
Retrieve recommended products
POST
Datocms webhook

Cart & Checkout APIs

Cart
Checkout

Coupons & promotions API

GET
Retrieve all coupons
GET
Retrieve all promotions

Customers API

GET
Retrieve all addresses
POST
Add address
GET
Retrieve particular address
PUT
Update particular address
DEL
Remove particular address
GET
Retrieve loyalty details
GET
List all loyalty points activity
GET
Retrieve all reviews

Orders APIs

GET
Retrieve all orders
POST
Create order
GET
Retrieve order detail
GET
Retrieve order shipments
GET
Retrieve order refunds
GET
Retrieve order payments
POST
Cancel order
POST
Retry payment

Shipping APIs

GET
Check pincode serviceability

Payments API

POST
Generate hash
GET
Retrieve available payment methods

Common API

GET
Retrieve all countries
GET
Retrieve country wise states
GET
Retrieve pincodes

Analytics

POST
Track event

Campaigns API

POST
Subscribe to newsletter

Create & Manage Users

Update user notification preferences

PUT

auth

user

{id}

notification-preferences

Authorization

string

Bearer

Authorization

Required

string

Access token

string

Required

string

user id

object

notification_preferences

object

notification_preferences

object

An object containing the user's notification preferences.

transactional

object

transactional

object

These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities.

boolean

Indicates whether the user has opted to receive notifications via email.

sms

boolean

sms

boolean

Indicates whether the user has opted to receive notifications via SMS.

boolean

Indicates whether the user has opted to receive notifications via WhatsApp.

promotional

object

promotional

object

These notifications aim to engage users with promotional content and enhance their overall experience with the platform.

boolean

Indicates whether the user has opted to receive notifications via email.

sms

boolean

sms

boolean

Indicates whether the user has opted to receive notifications via SMS.

boolean

Indicates whether the user has opted to receive notifications via WhatsApp.

newsletter

object

newsletter

object

These notifications are often sent periodically as part of a subscription service.

boolean

Indicates whether the user has opted to receive notifications via email.

sms

boolean

sms

boolean

Indicates whether the user has opted to receive notifications via SMS.

boolean

Indicates whether the user has opted to receive notifications via WhatsApp.

Authorizations

Authorization

string

headerrequired

Access token

Path Parameters

string

required

user id

Body

application/json

notification_preferences

object

An object containing the user's notification preferences.

Response

200 - application/json

message

string

A descriptive message confirming the success or failure of the operation.

success

boolean

Indicates whether the request was successful or failure (true for success, false for failure).

content

object

An object containing the response content.

Retrieve user notification preferences Create user notification preferences

twitter github linkedin