# Commerce Engine Docs

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

## Docs

- [AI-Assisted Development](https://www.commercengine.io/docs/ai/overview.md): Use AI coding assistants to build Commerce Engine integrations faster with LLM-optimized docs, agent skills, and ready-to-use prompts.
- [Prompts](https://www.commercengine.io/docs/ai/prompts.md): Ready-to-use prompts for AI coding assistants to build Commerce Engine integrations
- [Track event](https://www.commercengine.io/docs/api-reference/analytics/track-event.md): Track event
- [Add profile image](https://www.commercengine.io/docs/api-reference/auth/add-profile-image.md): Uploads a profile image for the user. Returns the `profile_image_url`.
- [Change password](https://www.commercengine.io/docs/api-reference/auth/change-password.md): Changes the authenticated user's password. Requires the current password and the new password.
- [Check email/phone verification status](https://www.commercengine.io/docs/api-reference/auth/check-emailphone-verification-status.md): Checks whether the user's email and phone number have been verified.
- [Create anonymous session](https://www.commercengine.io/docs/api-reference/auth/create-anonymous-session.md): Creates an anonymous user session with a persistent `user_id` for analytics and cart tracking. Returns an `AnonymousUser` object with `access_token` and `refresh_token`. Call this before any other authenticated endpoint for guest users.
- [Create user notification preferences](https://www.commercengine.io/docs/api-reference/auth/create-user-notification-preferences.md)
- [Deactivate account](https://www.commercengine.io/docs/api-reference/auth/deactivate-account.md): Deactivates the user's account.
- [Delete a user](https://www.commercengine.io/docs/api-reference/auth/delete-a-user.md): Deletes a user account. If the user is a primary user, deletes the associated customer and all linked users. If the user is a normal user, deletes only that user without affecting the customer or other users.
- [Delete profile image](https://www.commercengine.io/docs/api-reference/auth/delete-profile-image.md): Removes the profile image from the user account.
- [Forgot password](https://www.commercengine.io/docs/api-reference/auth/forgot-password.md): Initiates password recovery by sending an OTP. Returns an `otp_token` to pass to the reset-password endpoint.
- [Generate OTP](https://www.commercengine.io/docs/api-reference/auth/generate-otp.md): Generates and sends an OTP for authentication or verification. Returns an `otp_token` to pass to the verify-otp endpoint.
- [Login with email](https://www.commercengine.io/docs/api-reference/auth/login-with-email.md): Sends an OTP to the user's email address. Returns an `otp_token` to pass to the verify-otp endpoint. Set `register_if_not_exists` to `true` to auto-register new users on OTP verification.
- [Login with password](https://www.commercengine.io/docs/api-reference/auth/login-with-password.md): Authenticates a user with email/phone and password. Returns a `User` object with `access_token` and `refresh_token`.
- [Login with phone](https://www.commercengine.io/docs/api-reference/auth/login-with-phone.md): Sends an OTP to the user's phone number. Returns an `otp_token` to pass to the verify-otp endpoint. Set `register_if_not_exists` to `true` to auto-register new users on OTP verification.
- [Login with WhatsApp](https://www.commercengine.io/docs/api-reference/auth/login-with-whatsapp.md): Sends an OTP to the user's WhatsApp number. Returns an `otp_token` to pass to the verify-otp endpoint. Set `register_if_not_exists` to `true` to auto-register new users on OTP verification.
- [Logout user](https://www.commercengine.io/docs/api-reference/auth/logout-user.md): Invalidates the current session and logs the user out.
- [Refresh access token](https://www.commercengine.io/docs/api-reference/auth/refresh-access-token.md): Exchanges a `refresh_token` for a new `access_token` and `refresh_token` pair. Use this to extend user sessions without re-authentication.
- [Register with email](https://www.commercengine.io/docs/api-reference/auth/register-with-email.md): Registers a new user with their email address. Returns a `User` object with `access_token` and `refresh_token`.
- [Register with password](https://www.commercengine.io/docs/api-reference/auth/register-with-password.md): Registers a new user with email/phone and password. Returns a `User` object with `access_token` and `refresh_token`.
- [Register with phone](https://www.commercengine.io/docs/api-reference/auth/register-with-phone.md): Registers a new user with their phone number. Returns a `User` object with `access_token` and `refresh_token`.
- [Register with WhatsApp](https://www.commercengine.io/docs/api-reference/auth/register-with-whatsapp.md): Registers a new user with their WhatsApp number. Returns a `User` object with `access_token` and `refresh_token`.
- [Reset password](https://www.commercengine.io/docs/api-reference/auth/reset-password.md): Resets the user's password using the `otp_token` from the forgot-password endpoint. Returns new `access_token` and `refresh_token`.
- [Retrieve a profile image](https://www.commercengine.io/docs/api-reference/auth/retrieve-a-profile-image.md): Retrieves the `profile_image_url` for the user.
- [Retrieve a user](https://www.commercengine.io/docs/api-reference/auth/retrieve-a-user.md): Retrieves the full `User` object for a given user ID.
- [Retrieve user notification preferences](https://www.commercengine.io/docs/api-reference/auth/retrieve-user-notification-preferences.md)
- [Update a user](https://www.commercengine.io/docs/api-reference/auth/update-a-user.md): Updates user profile details. Returns the updated `User` object.
- [Update profile image](https://www.commercengine.io/docs/api-reference/auth/update-profile-image.md): Replaces the existing profile image. Returns the updated `profile_image_url`.
- [Update user notification preferences](https://www.commercengine.io/docs/api-reference/auth/update-user-notification-preferences.md)
- [Verify OTP](https://www.commercengine.io/docs/api-reference/auth/verify-otp.md): Verifies the OTP sent via phone, email, or WhatsApp. On success, returns a `User` object with `access_token` and `refresh_token`. Pass the `otp_token` and `otp_action` received from the login endpoint.
- [Subscribe to newsletter](https://www.commercengine.io/docs/api-reference/campaigns/subscribe-to-newsletter.md): Subscribe to newsletter
- [Add product to wishlist](https://www.commercengine.io/docs/api-reference/carts/add-product-to-wishlist.md): Adds a product to the user's wishlist. Returns the updated wishlist as an array of `Item` objects.
- [Add/delete cart item](https://www.commercengine.io/docs/api-reference/carts/adddelete-cart-item.md): Add Item to cart. To delete item from cart, pass quantity = 0
- [Apply coupon](https://www.commercengine.io/docs/api-reference/carts/apply-coupon.md): Apply coupon
- [Check fulfillment](https://www.commercengine.io/docs/api-reference/carts/check-fulfillment.md): Checking if fulfillment is available to the entered pincode based on shipping zones and inventories.
- [Create cart](https://www.commercengine.io/docs/api-reference/carts/create-cart.md): Create cart
- [Delete cart](https://www.commercengine.io/docs/api-reference/carts/delete-cart.md): delete all items from the cart.
- [Delete cart using user id](https://www.commercengine.io/docs/api-reference/carts/delete-cart-using-user-id.md): delete all items from the cart using user id.
- [Delete product from wishlist](https://www.commercengine.io/docs/api-reference/carts/delete-product-from-wishlist.md): Remove product from wishlist
- [Evaluate coupons](https://www.commercengine.io/docs/api-reference/carts/evaluate-coupons.md): Evaluate applicable & inapplicable coupons based on the specified cart.
- [Evaluate promotions](https://www.commercengine.io/docs/api-reference/carts/evaluate-promotions.md): Evaluate applicable & inapplicable promotions based on the specified cart.
- [Redeem loyalty points](https://www.commercengine.io/docs/api-reference/carts/redeem-loyalty-points.md): Redeem loyalty points
- [Remove coupon](https://www.commercengine.io/docs/api-reference/carts/remove-coupon.md): remove coupon from cart
- [Remove credit balance](https://www.commercengine.io/docs/api-reference/carts/remove-credit-balance.md): remove credit balance applied to cart
- [Remove loyalty points](https://www.commercengine.io/docs/api-reference/carts/remove-loyalty-points.md): Remove loyalty points applied in cart
- [Retrieve all coupons](https://www.commercengine.io/docs/api-reference/carts/retrieve-all-coupons.md): Retrieve active coupons
- [Retrieve all promotions](https://www.commercengine.io/docs/api-reference/carts/retrieve-all-promotions.md): All active promotions
- [Retrieve cart detail](https://www.commercengine.io/docs/api-reference/carts/retrieve-cart-detail.md): Retrieve cart detail
- [Retrieve cart using user id](https://www.commercengine.io/docs/api-reference/carts/retrieve-cart-using-user-id.md): Retrieve cart detail using user id
- [Retrieve fulfillment options](https://www.commercengine.io/docs/api-reference/carts/retrieve-fulfillment-options.md): Returns available fulfillment options for a cart and delivery pincode. The `summary` object indicates `collect_available`, `deliver_available`, and `recommended_fulfillment_type`. Use the `collect` array for Click & Collect store locations and `deliver` for delivery details.
- [Retrieve wishlist](https://www.commercengine.io/docs/api-reference/carts/retrieve-wishlist.md): Retrieve products in wishlist
- [Update cart address](https://www.commercengine.io/docs/api-reference/carts/update-cart-address.md): Update billing and shipping address
- [Update fulfillment preference](https://www.commercengine.io/docs/api-reference/carts/update-fulfillment-preference.md): Update fulfillment preference
- [Use credit balance](https://www.commercengine.io/docs/api-reference/carts/use-credit-balance.md): Use credit balance
- [Create product review](https://www.commercengine.io/docs/api-reference/catalog/create-product-review.md): Create a product review
- [List all categories](https://www.commercengine.io/docs/api-reference/catalog/list-all-categories.md): 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 product reviews](https://www.commercengine.io/docs/api-reference/catalog/list-all-product-reviews.md): 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 products](https://www.commercengine.io/docs/api-reference/catalog/list-all-products.md): Returns a paginated list of `Product` objects sorted by creation date (newest first). Pass `x-customer-group-id` header to retrieve group-specific pricing.
- [List all SKUs](https://www.commercengine.io/docs/api-reference/catalog/list-all-skus.md): Returns a list of SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
- [Retrieve a product detail](https://www.commercengine.io/docs/api-reference/catalog/retrieve-a-product-detail.md): Retrieves a single `ProductDetail` object by product ID or slug. Product slug is supported in place of product ID in the path. Includes full pricing, variants, images, attributes, and promotion data.
- [Retrieve cross-sell products](https://www.commercengine.io/docs/api-reference/catalog/retrieve-cross-sell-products.md): Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
- [Retrieve product variants](https://www.commercengine.io/docs/api-reference/catalog/retrieve-product-variants.md): Retrieves the variants of an existing product. Returns the corresponding variant list. Product slug is supported in place of product ID in the path.
- [Retrieve similar products](https://www.commercengine.io/docs/api-reference/catalog/retrieve-similar-products.md): 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 up-sell products](https://www.commercengine.io/docs/api-reference/catalog/retrieve-up-sell-products.md): Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
- [Retrieve variant detail](https://www.commercengine.io/docs/api-reference/catalog/retrieve-variant-detail.md): Retrieves the details of a particular variant. Product slug is supported in place of product ID, and variant slug in place of variant ID, in the path.
- [Search products](https://www.commercengine.io/docs/api-reference/catalog/search-products.md): Search for products matching a specific words or characters given.
- [Retrieve all countries](https://www.commercengine.io/docs/api-reference/common/retrieve-all-countries.md): Retrieve all countries
- [Retrieve country wise states](https://www.commercengine.io/docs/api-reference/common/retrieve-country-wise-states.md): Retrieve country wise states
- [Retrieve pincodes](https://www.commercengine.io/docs/api-reference/common/retrieve-pincodes.md): Retrieve pincodes
- [Create address](https://www.commercengine.io/docs/api-reference/customers/create-address.md)
- [List all loyalty points activity](https://www.commercengine.io/docs/api-reference/customers/list-all-loyalty-points-activity.md)
- [List all saved cards](https://www.commercengine.io/docs/api-reference/customers/list-all-saved-cards.md): Retrieve a list of saved payment cards for a given customer.
- [List all saved payment methods](https://www.commercengine.io/docs/api-reference/customers/list-all-saved-payment-methods.md): This endpoint acts as a proxy for JusPay's Fetch Saved Payment Methods API. It enables to securely retrieve a list of payment methods (such as saved cards, UPI handles, wallets) that have been previously stored for a given customer.
- [Remove particular address](https://www.commercengine.io/docs/api-reference/customers/remove-particular-address.md)
- [Retrieve all addresses](https://www.commercengine.io/docs/api-reference/customers/retrieve-all-addresses.md)
- [Retrieve all reviews](https://www.commercengine.io/docs/api-reference/customers/retrieve-all-reviews.md)
- [Retrieve loyalty details](https://www.commercengine.io/docs/api-reference/customers/retrieve-loyalty-details.md)
- [Retrieve particular address](https://www.commercengine.io/docs/api-reference/customers/retrieve-particular-address.md)
- [Update particular address](https://www.commercengine.io/docs/api-reference/customers/update-particular-address.md)
- [Getting Started](https://www.commercengine.io/docs/api-reference/getting-started.md): Learn how to authenticate with the Commerce Engine API and make your first request.
- [Create customer in juspay](https://www.commercengine.io/docs/api-reference/juspay/create-customer-in-juspay.md): Create customer in juspay.
- [Create order in juspay](https://www.commercengine.io/docs/api-reference/juspay/create-order-in-juspay.md): Creates an order in the Juspay system and fetches the corresponding client_auth_token. To be used for Express Checkout integration.
- [Retrieve customer from juspay](https://www.commercengine.io/docs/api-reference/juspay/retrieve-customer-from-juspay.md)
- [Create document](https://www.commercengine.io/docs/api-reference/kyc/create-document.md)
- [Delete document](https://www.commercengine.io/docs/api-reference/kyc/delete-document.md)
- [List all documents](https://www.commercengine.io/docs/api-reference/kyc/list-all-documents.md)
- [List KYC documents](https://www.commercengine.io/docs/api-reference/kyc/list-all-kyc-documents.md): Retrieves the list of KYC document types required for the store. Returns an array of `Kyc Document` objects defining document types, mandatory flags, and verification settings.
- [Retrieve document detail](https://www.commercengine.io/docs/api-reference/kyc/retrieve-document-detail.md)
- [Update document detail](https://www.commercengine.io/docs/api-reference/kyc/update-document-detail.md)
- [Verify document](https://www.commercengine.io/docs/api-reference/kyc/verify-document.md)
- [Create product review](https://www.commercengine.io/docs/api-reference/marketplace/create-product-review.md): Create a product review
- [List all categories](https://www.commercengine.io/docs/api-reference/marketplace/list-all-categories.md): 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 product reviews](https://www.commercengine.io/docs/api-reference/marketplace/list-all-product-reviews.md): 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 products](https://www.commercengine.io/docs/api-reference/marketplace/list-all-products.md): Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
- [List all SKUs](https://www.commercengine.io/docs/api-reference/marketplace/list-all-skus.md): Returns a list of SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
- [Retrieve a product detail](https://www.commercengine.io/docs/api-reference/marketplace/retrieve-a-product-detail.md)
- [Retrieve cross-sell products](https://www.commercengine.io/docs/api-reference/marketplace/retrieve-cross-sell-products.md): Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
- [Retrieve product variants](https://www.commercengine.io/docs/api-reference/marketplace/retrieve-product-variants.md): Retrieves the variants of an existing marketplace product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product variants information.
- [Retrieve similar products](https://www.commercengine.io/docs/api-reference/marketplace/retrieve-similar-products.md): 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 up-sell products](https://www.commercengine.io/docs/api-reference/marketplace/retrieve-up-sell-products.md): Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
- [Retrieve variant detail](https://www.commercengine.io/docs/api-reference/marketplace/retrieve-variant-detail.md): Retrieves the details of a particular marketplace variant. Product slug is supported in place of product ID, and variant slug in place of variant ID, in the path.
- [Search products](https://www.commercengine.io/docs/api-reference/marketplace/search-products.md): Search for products matching a specific words or characters given.
- [Order cancelled](https://www.commercengine.io/docs/api-reference/order-cancelled.md)
- [Order completed](https://www.commercengine.io/docs/api-reference/order-completed.md)
- [Order confirmed](https://www.commercengine.io/docs/api-reference/order-confirmed.md)
- [Order created](https://www.commercengine.io/docs/api-reference/order-created.md)
- [Cancel order](https://www.commercengine.io/docs/api-reference/orders/cancel-order.md): Cancels an order. Only available when `is_cancellation_allowed` is `true` on the order. Returns the updated `OrderDetail` object. Requires a `cancellation_reason` and `refund_mode`.
- [Cancel payment request](https://www.commercengine.io/docs/api-reference/orders/cancel-payment-request.md): Use when the express checkout payment flow is used and the user wants to switch payment methods (e.g. started with UPI, then chose another). Without this call, the user must wait until the payment-status API returns `status: failed` and `is_retry_available: true` (typically ~3 minutes). Calling this…
- [Create order](https://www.commercengine.io/docs/api-reference/orders/create-order.md): Creates an order from a cart. Returns an `Order` object along with `payment_required` and `payment_info`. When `payment_required` is `true`, use `payment_info` to initiate the payment flow, then poll `/orders/{order_number}/payment-status` from your return URL.
- [Create order return](https://www.commercengine.io/docs/api-reference/orders/create-order-return.md): Initiates a return request for delivered items in an order. Returns an `OrderReturn` object.
- [Retrieve all order returns](https://www.commercengine.io/docs/api-reference/orders/retrieve-all-order-returns.md): Lists all return requests across all orders. Returns an array of `OrderReturn` objects.
- [Retrieve all orders](https://www.commercengine.io/docs/api-reference/orders/retrieve-all-orders.md): Lists all orders for a user. Returns an array of `OrderList` objects with pagination.
- [Retrieve order detail](https://www.commercengine.io/docs/api-reference/orders/retrieve-order-detail.md): Retrieves the full `OrderDetail` object for a given order number.
- [Retrieve order payments](https://www.commercengine.io/docs/api-reference/orders/retrieve-order-payments.md): Retrieve order payments
- [Retrieve order refunds](https://www.commercengine.io/docs/api-reference/orders/retrieve-order-refunds.md): Retrieve order refunds
- [Retrieve order return detail](https://www.commercengine.io/docs/api-reference/orders/retrieve-order-return-detail.md): Retrieves the full `OrderReturn` object for a specific return request.
- [Retrieve order shipments](https://www.commercengine.io/docs/api-reference/orders/retrieve-order-shipments.md): Retrieve order shipments
- [Retrieve payment status](https://www.commercengine.io/docs/api-reference/orders/retrieve-payment-status.md): Retrieve payment status of a paricular order.
- [Retry payment](https://www.commercengine.io/docs/api-reference/orders/retry-payment.md): 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.
- [Payment failed](https://www.commercengine.io/docs/api-reference/payment-failed.md)
- [Payment retried](https://www.commercengine.io/docs/api-reference/payment-retried.md)
- [Payment successful](https://www.commercengine.io/docs/api-reference/payment-successful.md)
- [Authenticate direct OTP](https://www.commercengine.io/docs/api-reference/payments/authenticate-direct-otp.md): Authenticate direct OTP
- [Get card information](https://www.commercengine.io/docs/api-reference/payments/get-card-information.md): Retrieve card information based on the initial 9 digits (card BIN) of the card number.
- [List all payment methods](https://www.commercengine.io/docs/api-reference/payments/list-all-payment-methods.md): List all payment methods
- [Resend direct OTP](https://www.commercengine.io/docs/api-reference/payments/resend-direct-otp.md): Resend direct OTP
- [Verify VPA](https://www.commercengine.io/docs/api-reference/payments/verify-vpa.md): 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 hel…
- [Generate hash](https://www.commercengine.io/docs/api-reference/payu/generate-hash.md): Generate PayU hash
- [Add/delete cart item](https://www.commercengine.io/docs/api-reference/pos/adddelete-cart-item.md): Add Item to cart. To delete item from cart, pass quantity = 0
- [Apply coupon](https://www.commercengine.io/docs/api-reference/pos/apply-coupon.md): Apply coupon
- [Claim device](https://www.commercengine.io/docs/api-reference/pos/claim-device.md): Claim device
- [Create cart](https://www.commercengine.io/docs/api-reference/pos/create-cart.md): Create cart
- [Create order](https://www.commercengine.io/docs/api-reference/pos/create-order.md): Creates a new order from a POS device.
- [Delete cart](https://www.commercengine.io/docs/api-reference/pos/delete-cart.md): delete all items from the cart.
- [Evaluate coupons](https://www.commercengine.io/docs/api-reference/pos/evaluate-coupons.md): Evaluate applicable & inapplicable coupons based on the specified cart.
- [Evaluate promotions](https://www.commercengine.io/docs/api-reference/pos/evaluate-promotions.md): Evaluate applicable & inapplicable promotions based on the specified cart.
- [Get POS User](https://www.commercengine.io/docs/api-reference/pos/get-pos-user.md): Get POS User
- [List all available devices](https://www.commercengine.io/docs/api-reference/pos/list-all-available-devices.md): List all available devices.
- [List all categories](https://www.commercengine.io/docs/api-reference/pos/list-all-categories.md): 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 locations](https://www.commercengine.io/docs/api-reference/pos/list-all-locations.md): List all locations.
- [List all product reviews](https://www.commercengine.io/docs/api-reference/pos/list-all-product-reviews.md): 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 products](https://www.commercengine.io/docs/api-reference/pos/list-all-products.md): Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
- [List all SKUs](https://www.commercengine.io/docs/api-reference/pos/list-all-skus.md): Returns a list of SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
- [Login with email](https://www.commercengine.io/docs/api-reference/pos/login-with-email.md): Login to POS device using email. Login to POS device using phone.  The endpoint requires authentication with an API key that has the scope set to 'storefront' for a particular store, ensuring secure access for user login operation.
- [Login with phone](https://www.commercengine.io/docs/api-reference/pos/login-with-phone.md): Login to POS device using phone.  The endpoint requires authentication with an API key that has the scope set to 'storefront' for a particular store, ensuring secure access for user login operation.
- [Login with whatsapp](https://www.commercengine.io/docs/api-reference/pos/login-with-whatsapp.md): Login to POS device using whatsapp. Login to POS device using phone.  The endpoint requires authentication with an API key that has the scope set to 'storefront' for a particular store, ensuring secure access for user login operation.
- [Logout](https://www.commercengine.io/docs/api-reference/pos/logout.md): This endpoint ends the current loggedin session for the POS device. This action immediately invalidates the previously issued access token(s), preventing any further use. A new login is required to regain access.
- [Pair POS device](https://www.commercengine.io/docs/api-reference/pos/pair-pos-device.md): This endpoint allows a POS device to be activated by submitting a valid pairing code received via phone or email. The endpoint requires authentication with an API key that has the scope set to 'storefront' for a particular store, ensuring secure access for device activation operation.
- [Redeem loyalty points](https://www.commercengine.io/docs/api-reference/pos/redeem-loyalty-points.md): Redeem loyalty points
- [Refresh POS access token](https://www.commercengine.io/docs/api-reference/pos/refresh-pos-access-token.md): Refresh POS access token
- [Remove coupon](https://www.commercengine.io/docs/api-reference/pos/remove-coupon.md): remove coupon from cart
- [Remove credit balance](https://www.commercengine.io/docs/api-reference/pos/remove-credit-balance.md): remove credit balance applied to cart
- [Remove loyalty points](https://www.commercengine.io/docs/api-reference/pos/remove-loyalty-points.md): Remove loyalty points applied in cart
- [Retrieve a product detail](https://www.commercengine.io/docs/api-reference/pos/retrieve-a-product-detail.md)
- [Retrieve all coupons](https://www.commercengine.io/docs/api-reference/pos/retrieve-all-coupons.md): Retrieve active coupons
- [Retrieve all promotions](https://www.commercengine.io/docs/api-reference/pos/retrieve-all-promotions.md): All active promotions
- [Retrieve cart detail](https://www.commercengine.io/docs/api-reference/pos/retrieve-cart-detail.md): Retrieve cart detail
- [Retrieve cart using user id](https://www.commercengine.io/docs/api-reference/pos/retrieve-cart-using-user-id.md): Retrieve cart detail using user id
- [Retrieve cross-sell products](https://www.commercengine.io/docs/api-reference/pos/retrieve-cross-sell-products.md): Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
- [Retrieve fulfillment options](https://www.commercengine.io/docs/api-reference/pos/retrieve-fulfillment-options.md): This endpoint returns the available fulfillment options for a given cart and delivery pincode. It provides both delivery options and collect-in-store (Click & Collect) options, including details of store locations where the item can be collected.
- [Retrieve payment status](https://www.commercengine.io/docs/api-reference/pos/retrieve-payment-status.md): Retrieve payment status of a paricular order.
- [Retrieve product variants](https://www.commercengine.io/docs/api-reference/pos/retrieve-product-variants.md): Retrieves the variants of an existing product. Product slug is supported in place of product ID in the path. Commerce Engine returns the corresponding product variants information.
- [Retrieve similar products](https://www.commercengine.io/docs/api-reference/pos/retrieve-similar-products.md): 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 up-sell products](https://www.commercengine.io/docs/api-reference/pos/retrieve-up-sell-products.md): Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
- [Retrieve variant detail](https://www.commercengine.io/docs/api-reference/pos/retrieve-variant-detail.md): Retrieves the details of a particular variant. Product slug is supported in place of product ID, and variant slug in place of variant ID, in the path.
- [Search products](https://www.commercengine.io/docs/api-reference/pos/search-products.md): Search for products matching a specific words or characters given.
- [Unclaim device](https://www.commercengine.io/docs/api-reference/pos/unclaim-device.md): Unclaim device
- [Update cart address](https://www.commercengine.io/docs/api-reference/pos/update-cart-address.md): Update billing and shipping address
- [Update cart customer](https://www.commercengine.io/docs/api-reference/pos/update-cart-customer.md): Link customer to the specified cart.
- [Update fulfillment preference](https://www.commercengine.io/docs/api-reference/pos/update-fulfillment-preference.md): Update fulfillment preference
- [Use credit balance](https://www.commercengine.io/docs/api-reference/pos/use-credit-balance.md): Use credit balance
- [Verify OTP](https://www.commercengine.io/docs/api-reference/pos/verify-otp.md): Verify POS login otp. Login to POS device using phone.  The endpoint requires authentication with an API key that has the scope set to 'storefront' for a particular store.
- [Refund failed](https://www.commercengine.io/docs/api-reference/refund-failed.md)
- [Refund initiated](https://www.commercengine.io/docs/api-reference/refund-initiated.md)
- [Refund successful](https://www.commercengine.io/docs/api-reference/refund-successful.md)
- [Shipment cancelled](https://www.commercengine.io/docs/api-reference/shipment-cancelled.md)
- [Shipment created](https://www.commercengine.io/docs/api-reference/shipment-created.md)
- [Shipment delivered](https://www.commercengine.io/docs/api-reference/shipment-delivered.md)
- [Shipment updated](https://www.commercengine.io/docs/api-reference/shipment-updated.md)
- [Check store existence](https://www.commercengine.io/docs/api-reference/store/check-store-existence.md): Checks whether a store with the given ID exists. Returns `success: true` if the store exists, `false` otherwise.
- [List seller reviews](https://www.commercengine.io/docs/api-reference/store/list-seller-reviews.md): List seller reviews by seller ID
- [Retrieve seller detail](https://www.commercengine.io/docs/api-reference/store/retrieve-seller-detail.md): Retrieve seller detail by ID
- [Retrieve store config](https://www.commercengine.io/docs/api-reference/store/retrieve-store-config.md): Retrieve store config detail
- [Create subscription](https://www.commercengine.io/docs/api-reference/subscriptions/create-subscription.md): Creates a new subscription for a customer. Returns the created `SubscriptionDetail` object.
- [List all subscriptions](https://www.commercengine.io/docs/api-reference/subscriptions/list-all-subscriptions.md): List all subscriptions
- [Retrieve subscription details](https://www.commercengine.io/docs/api-reference/subscriptions/retrieve-subscription-details.md): Retrieve subscription details
- [Update a specific subscription](https://www.commercengine.io/docs/api-reference/subscriptions/update-a-specific-subscription.md): Update a specific subscription
- [Astro](https://www.commercengine.io/docs/hosted-checkout/astro.md): Integrate Commerce Engine Checkout into Astro sites using the root checkout helpers. No dedicated binding needed — works with ClientRouter and framework islands.
- [Checkout Studio](https://www.commercengine.io/docs/hosted-checkout/checkout-studio.md): A no-code dashboard for configuring Hosted Checkout with real-time preview and instant publishing.
- [Configuration](https://www.commercengine.io/docs/hosted-checkout/configuration.md): Full reference for all Hosted Checkout configuration options, events, and methods.
- [Overview](https://www.commercengine.io/docs/hosted-checkout/overview.md): Drop-in checkout for any website or app. A fully hosted, embeddable checkout experience that handles cart, payments, and order completion.
- [React](https://www.commercengine.io/docs/hosted-checkout/react.md): Integrate Commerce Engine Checkout into React apps with the useCheckout hook. Reactive state, no providers required.
- [Solid](https://www.commercengine.io/docs/hosted-checkout/solid.md): Integrate Commerce Engine Checkout into SolidJS apps with fine-grained reactive signals.
- [Svelte](https://www.commercengine.io/docs/hosted-checkout/svelte.md): Integrate Commerce Engine Checkout into Svelte 5 apps with readable stores.
- [Vanilla JS / CDN](https://www.commercengine.io/docs/hosted-checkout/vanilla-js.md): Add Commerce Engine Checkout to any website with a single script tag. No build step required.
- [Vue](https://www.commercengine.io/docs/hosted-checkout/vue.md): Integrate Commerce Engine Checkout into Vue 3 apps with the useCheckout composable. Returns reactive refs with automatic cleanup.
- [Astro](https://www.commercengine.io/docs/sdk/astro-integration.md): First-class Astro wrapper with cookie-backed sessions, SSR pages, API routes, middleware, and static prerendering support.
- [Client Overview](https://www.commercengine.io/docs/sdk/client-overview.md): Overview of SDK clients with type safety and automatic token management
- [Configuration](https://www.commercengine.io/docs/sdk/configuration.md): Complete guide to configuring the TypeScript SDK for different environments and use cases
- [Debugging & Performance](https://www.commercengine.io/docs/sdk/debugging-performance.md): Debug SDK issues with built-in logging and monitoring tools
- [Error Handling](https://www.commercengine.io/docs/sdk/error-handling.md): SDK-specific error handling patterns with type safety and automatic recovery
- [Installation & Quick Start](https://www.commercengine.io/docs/sdk/installation.md): Get started with the CommerceEngine TypeScript SDK in minutes
- [Middleware System](https://www.commercengine.io/docs/sdk/middleware-system.md): SDK middleware for authentication, token management, and debugging
- [Migration Guide](https://www.commercengine.io/docs/sdk/migration-guide.md): Migrate from direct API calls to the type-safe SDK
- [Next.js](https://www.commercengine.io/docs/sdk/nextjs-integration.md): Integrate the Commerce Engine Storefront SDK into Next.js with server-side session management, cookie-backed tokens, and three distinct accessors for every rendering context.
- [Node JS](https://www.commercengine.io/docs/sdk/nodejs-integration.md): Complete guide to using the SDK in Node.js backend applications
- [React](https://www.commercengine.io/docs/sdk/react-integration.md): Complete guide to integrating the SDK with React applications
- [SvelteKit](https://www.commercengine.io/docs/sdk/sveltekit-integration.md): First-class SvelteKit wrapper with cookie-backed sessions, server load functions, form actions, hooks, and universal load support.
- [TanStack Start](https://www.commercengine.io/docs/sdk/tanstack-start-integration.md): First-class TanStack Start wrapper with automatic token management, server functions, and pre-rendering support
- [Token Management](https://www.commercengine.io/docs/sdk/token-management.md): Complete guide to authentication and token management in the TypeScript SDK
- [Type Safety](https://www.commercengine.io/docs/sdk/type-safety.md): 100% type-safe SDK with IntelliSense, compile-time checking, and OpenAPI-generated types
- [Authentication](https://www.commercengine.io/docs/storefront/authentication.md): 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.
- [Cart](https://www.commercengine.io/docs/storefront/cart.md): 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 fulfillment options, and retrieve the cart's state before checkout. Commerce Engine carts are persistent and associated with the user (anony…
- [Catalog](https://www.commercengine.io/docs/storefront/catalog.md): 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, power…
- [Checkout](https://www.commercengine.io/docs/storefront/checkout.md): 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.
- [My Account](https://www.commercengine.io/docs/storefront/my-account.md): 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.
- [Quickstart](https://www.commercengine.io/docs/storefront/quickstart.md): 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.
- [Subscriptions](https://www.commercengine.io/docs/storefront/subscriptions.md): 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…

## OpenAPI Specs

- [ce-storefront](https://openapi.commercengine.io/ce-storefront.json)
- [ce-storefront-openapi](https://www.commercengine.io/docs/storefront-api-reference/ce-storefront-openapi.json)
- [ce-storefront-api](https://www.commercengine.io/docs/api-reference/ce-storefront-api.json)
- [openapi](https://www.commercengine.io/docs/api-reference/openapi.json)