Delete document

Not authorized for given operation on the Resource

Commerce Engine is now in beta. We're working hard to make it better for you.

Official documentation for Commerce Engine - The modern headless commerce platform for building scalable e-commerce solutions.

Commerce Engine Docs

Everything you need to build powerful, custom commerce experiences.

Introduction

Let's get you up and running with the Commerce Engine Storefront API. This guide covers the basics: obtaining credentials, understanding environments, and making your first API call.

Quickstart

Authentication verifies the identity of the user interacting with your storefront. Commerce Engine uses a robust token-based system (JWT) and offers flexible login methods, including passwordless options via Email, Phone, and WhatsApp.

Authentication

The Catalog module is the cornerstone of your Commerce Engine storefront. It defines everything you sell – products, their variations, how they're organized, priced, and described. Mastering these APIs allows you to build compelling product listings, detailed descriptions, category navigation, powerful search, customer reviews, and insightful recommendations.

Catalog

The Carts module provides the APIs to manage a user's shopping cart. It allows you to add, update, and remove items, apply discounts and loyalty points, manage addresses, and retrieve the cart's state before checkout. Commerce Engine carts are persistent and associated with the user (anonymous or logged-in), enabling seamless experiences across sessions or devices.

Cart

This guide walks you through the process of converting a customer's shopping cart into a placed order, including address validation, shipping checks, payment processing, and handling payment retries. It utilizes endpoints primarily from the Carts, Orders, Payments, Shipping, and Common modules.

Checkout

This section details the APIs used to build the "My Account" area of your storefront, allowing logged-in customers to manage their profile, view past orders, handle returns or cancellations, update addresses, track loyalty points, and manage their reviews.

My Account

The Subscriptions module allows you to offer products and services on a recurring basis, enabling business models like "Subscribe & Save," SaaS, content access, and custom refill schedules. Commerce Engine provides APIs to define subscription plans on products, let users initiate subscriptions, and manage the lifecycle of those subscriptions.

Subscriptions

Follow these steps to configure your Commerce Engine organization and start placing orders.

First steps

Important settings to help you configure our store to behave the way you want

Store Settings

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 ID, 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.

Anonymous user

This API enables users to authenticate into the system using their phone number. It provides a secure way for users to log in by verifying their identity through a one-time password (OTP) sent to their registered phone.

Login with phone

This API enables users to authenticate into the system using their email address. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their email address.

Login with email

This API enables users to authenticate into the system using their WhatsApp Number. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their WhatsApp Number.

Login with whatsapp

This API endpoint allows users to Login using their password. It requires the following parameters: email/phone and password. Also allows users to securely Login and obtain access and refresh tokens for subsequent API calls.

Login with password

This API endpoint allows you to verify a one-time password (OTP) for authentication purposes. By sending a request to this endpoint with the necessary parameters, you can confirm the validity of the OTP provided by the user.

Verify OTP

This API provides the functionality to register a user using their phone number. This allows you to securely register users and obtain access and refresh tokens for subsequent API calls.

Register with phone

The API allows users to register with their email address. This endpoint enables the registration process by requesting the user's email, first name, last name, phone number, and OTP token.
The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.

Register with email

The API allows users to register with their WhatsApp. This endpoint enables the registration process by requesting the user's WhatsApp number, first name, last name, email, and OTP token.
The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.


Register with whatsapp

The User Registration with Password API facilitates user onboarding by allowing registration through a combination of phone number and email. API collects essential registration details, including phone number, email, password and the confirmation of the chosen password.
The response will include a message indicating the success or failure of the registration process, as well as additional information such as the user's information, access token and refresh token.

Register with password

The Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.

Retrieve a user

The Update User API helps to efficiently modify and enhance user information within the system, ensuring that user profiles remain accurate and up-to-date. This API provides a secure and flexible mechanism for updating specific details while maintaining adherence to established conventions.

Update a user

Retrieve user profile image API streamlines the process of retriving profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.

Retrieve a profile image

The Profile Image API streamlines the process of updating profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.

Update profile image

The Profile Image API streamlines the process of uploading profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.

Add profile image

Delete profile image API streamlines the process of removing profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.

Delete profile image

The Deactivate Account API providing users with a straightforward method to deactivate their accounts. Upon successful deactivation, the API responds with a confirmation message. Error responses are detailed, aiding developers in addressing issues promptly.

Deactivate account

The Refresh Access Token API is an integral component designed to enhance security and user experience. It enables clients to refresh their access tokens seamlessly, extending user sessions without compromising security.

Refresh access token

The Change Password API is a key feature designed to provide a secure and standardized method for users to update their passwords.

Change password

The Forgot Password API provides a secure mechanism for users to initiate the password recovery process. This API provides one-time password (OTP) token, which facilitas the resetting of user’s account password.

Forgot password

Reset password

The Retrieve Notification Preferences API allows clients to fetch a user's notification preferences based on their unique user identifier (user_id).

Retrieve user notification preferences

Update Notification Preferences API allows clients to update a user's notification preferences based on their unique user identifier (user_id).

Update user notification preferences

Create user notification preferences API allows clients to create a user's notification preferences based on their unique user identifier (user_id).

Create user notification preferences

Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.

Generate OTP

The Logout User API initiate the logout process for a user. Upon a successful request, the API responds with a confirmation message. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.

Logout user

The Check Verification Status API allows to verify the status of email and phone number verification for a specific user. Upon a successful request, the API responds with the verification status of the provided email and phone number. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.

Check email/phone verification status

Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.

List all products

Returns a list of SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.

List all SKUs

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Commerce Engine will return the corresponding product information.

Retrieve a product detail

Retrieves the variants of an existing product. Supply the unique product ID, and Commerce Engine will return the corresponding product variants information.

Retrieve product variants

Retrieves the details of a particular variant. Supply the unique product ID, and variant ID.

Retrieve variant detail

Returns a list of your product categories. The categories are returned sorted by creation date, with the most recently created categories appearing first.

List all categories

List of reviews for a specified product. The reviews are returned sorted by submission date, with the most recent reviews appearing first. You can filter the reviews by rating, reviewer, or date for more detailed analysis.

List all product reviews

Create product review

Retrieves a list of products similar to a specified product based on their attributes and category. The similar products are returned sorted by relevance, with the most closely matching products appearing first. Useful for providing product recommendations to your customers.

Retrieve similar products

Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.

Retrieve up-sell products

Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.

Retrieve cross-sell products

Search for products matching a specific words or characters given.

Search products

Create cart

Retrieve cart detail

Delete cart

Retrieve cart using user id

delete all items from the cart using user id.

Delete cart using user id

Add Item to cart. To delete item from cart, pass quantity = 0

Add/delete cart item

Update cart address

Apply coupon

Remove coupon

Redeem loyalty points

Remove loyalty points

Use credit balance

Remove credit balance

Redeem gift card

Remove gift card

Retrieve wishlist

Add product to wishlist

Delete product from wishlist

Retrieve all coupons

Retrieve all promotions

Create customer

Retrieve customer detail

Update customer detail

Retrieve billing and shipping address of particular customer

Retrieve all addresses

Create address

Retrieve particular address

Update particular address

Remove particular address

Retrieve loyalty details

List all loyalty points activity

Retrieve all reviews

List all kyc documents added for a particular store.

List all kyc documents

List all documents added by a particular customer.

List all documents

Create document

Retrieve document detail

Update document detail

Verify document

Retrieve all orders

Create order

Retrieve order detail

Retrieve payment status of a paricular order.

Retrieve payment status

Retrieve order shipments

Retrieve order refunds

Retrieve order payments

Create order return

Retrieve order return detail

Cancel order

To generate new payment request if first payment request is failed or expired. Retry payment request can be made after 15 mins of last request or immediately after last payment request is marked as failed.

Retry payment

Retrieve all order returns

Check shipment delivery availability in an area by pincode

Check pincode deliverability

Generate hash

List all payment methods

List all saved cards

Add card

The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service to send or receive money. In the case of UPI collect VPA is the mandatory param and merchants are always advised to check if the VPA is valid or not.
Validating the VPA will help in reducing the failure rate due to incorrect vpa. 

Verify VPA

Creates an order in the Juspay system and fetches the corresponding client_auth_token.
To be used for Express Checkout integration.

Create order in juspay

Create customer in juspay

Retrieve customer from juspay

Retrieve all countries

Retrieve country wise states

Retrieve pincodes

Track event

Subscribe to newsletter

List all subscriptions

Create subscription

Retrieve subscription details

Update a specific subscription

Welcome to the home of your new documentation

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

Example section for showcasing API endpoints

Auth

Catalog

Carts

Coupons & promotions

Customers

KYC

Orders

Shipping

PayU

Payments

Juspay

Common

Analytics

Campaigns

Subscriptions

Delete document

Path Parameters

Response