Documentation

Commerce Engine Docs

Storefront API Reference

Admin API Reference

Return to site

Support

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.

NotificationChannelPreferences

Set channel preferences for each type of 

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


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

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

NotificationPreferences

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.

Timestamps indicate when the user's account was created.

The unique identifier (ULID) of the user.

Boolean indicating whether the email is verified.

Indicates whether the user is currently logged in.

Boolean indicating whether the phone is verified.

Timestamps indicating when the user account was last modified.

User's notification preferences are categorized by transactional, promotional, and newsletter types.

10 digit phone number without country code.

User

This API’s focus is on anonymous users who have not undergone the formal account creation process. These anonymous users are associated with a unique identifier called a ULID, ensuring that even in the absence of a fully realized account, there is a distinct and trackable identity for each user. 
To interact with the system, each anonymous user is issued an access token. This access token plays a dual role in the system: it serves as a means of authenticating the user and it also acts as a tool for authorization, determining what actions the authenticated user is permitted to perform.

X Api Key

Anonymous user

Welcome to the home of your new documentation

Introduction

Getting Started with Commerce Engine Storefront APIs

Quickstart

Learn about the various Commerce Engine modules and how to use them to add features to your storefront

Modules

You can customise the behaviour of your storefront by updating the store settings from the Commerce Engine app

Store Settings

Example section for showcasing API endpoints

API Documentation

Authentication APIs

Catalog APIs

Cart & Checkout APIs

Coupons & promotions API

Customers API

Orders APIs

Shipping APIs

Payments API

Common API

Analytics

Campaigns API

Anonymous user

Authorizations

Response