Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

Directs the browser to navigate to the site visitor's Cart Page.

The `navigateToCartPage()` function returns a Promise that resolves when the browser successfully navigates to the [Cart Page](https://support.wix.com/en/article/customizing-the-cart-page).

import wixEcomFrontend from 'wix-ecom-frontend';
import wixEcomBackend from 'wix-ecom-backend';

$w('#myNavigateToCartPageButton').onClick(() => {

  // example values for the options object
  const options = {
    lineItems: [{
      catalogReference: {
        // Wix Stores appId
        appId: '215238eb-22a5-4c36-9e7b-e7c08025e04e',
        // Wix Stores productId
        catalogItemId: '3fb6a3c8-988b-8755-04bd-5c59ae0b18ea',
      },
      quantity: 1
    }]
  };

  // The wixEcomBackend.currentCart module is universal.
  // You can call its methods in frontend and backend code.
  wixEcomBackend.currentCart.addToCurrentCart(options)
    .then(() => {
      console.log('item added to cart');
      // navigate to cart page after adding item
      wixEcomFrontend.navigateToCartPage();
    })
    .catch((error) => {
      console.error(error);
      // Handle the error
    });
});

Navigate to the cart page

navigateToCartPage

void

Fulfilled - When the navigation is complete.

checkoutId

string

Additional parameters for customizing the checkout flow.

options

CheckoutPageOptions

Directs the browser to navigate to the site visitor's Checkout Page.

The `navigateToCheckoutPage()` function returns a Promise that resolves when the browser successfully navigates to the [Checkout Page](https://support.wix.com/en/article/customizing-the-checkout-page).

> **Note:** The `checkoutId` parameter is **required**. To get a `checkoutId`, use one of the following `wix-ecom-backend` functions:
> + [`createCheckoutFromCurrentCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/current-cart/create-checkout-from-current-cart)
> + [`cart.createCheckout()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/cart/create-checkout)
> + [`checkout.createCheckout()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-backend/checkout/create-checkout)

import wixEcomFrontend from 'wix-ecom-frontend';

$w('#myNavigateToCheckoutPageButton').onClick(() => {

  // Example checkoutId and options values
  const checkoutId = '12345678-1234-1234-1234-1234567890ab';
  const options = {
    skipDeliveryStep: true,
    hideContinueBrowsingButton: false,
    overrideContinueBrowsingUrl: 'https://www.myExampleSite.com/upsellPage',
    // override ThankYouPage URL with dynamic orderId parameter
    overrideThankYouPageUrl: 'https://www.myExampleSite.com/customThankYouPage/{orderId}'
  };

  wixEcomFrontend.navigateToCheckoutPage(checkoutId, options)
    .then(() => {
      console.log('Navigated successfully');
    })
    .catch((error) => {
      console.error(error);
      // Handle the error
    });
});

Navigate to the checkout page

navigateToCheckoutPage

The name of the function or the function expression to run when the cart is changed.

handler

onCartChangeHandler

Adds an event handler that runs when the cart changes.

The event handler set by the `onCartChange()` function runs when the cart changes.

The `onCartChange()` event handler is triggered when:
+ The cart is modified by native UI elements such as the 'Add to Cart' button, increase (+) and decrease (-) item quantity buttons, remove line item button (x), etc.
+ The [`refreshCart()`](https://dev.wix.com/docs/velo/api-reference/wix-ecom-frontend/refresh-cart) function is called.



**Important:** Actions performed by Velo functions other than the `refreshCart()` function do not trigger the `onCartChange()` event handler.

import wixEcomFrontend from 'wix-ecom-frontend';
import wixEcomBackend from 'wix-ecom-backend';

$w.onReady(function () {

  // handler function that gets the current cart on cart change
  const handler = () => {
      // The wixEcomBackend.currentCart module is universal.
      // You can call its methods in frontend and backend code.
    wixEcomBackend.currentCart.getCurrentCart()
      .then(cart => {
        let cartId = cart._id;
        console.log('cart ID: ', cartId);
      })
      .catch(error => {
        console.error(error);
        // Handle the error
      });
  };

  wixEcomFrontend.onCartChange(handler);
});

Add an event handler for cart changes

onCartChange

Opens the Side Cart panel.

The `openSideCart()` function opens the Side Cart panel on the current page.

> **Notes:**
> + We are gradually replacing the existing [Mini Cart](https://support.wix.com/en/article/customizing-the-mini-cart) with the new Side Cart panel.
> + This function will fail when viewing the site on mobile because there is no Mini Cart on the mobile site.
> + The new Side Cart works on mobile sites. When Side Cart functionality becomes available for your site, `openSideCart()` will work on mobile.

import wixEcomFrontend from 'wix-ecom-frontend';

$w('#myOpenSideCartButton').onClick(() => {
  // on button click - open the side cart
  wixEcomFrontend.openSideCart();
});

Open the Side Cart

openSideCart

Updates cart UI elements, like the [Cart Icon](https://support.wix.com/en/article/customizing-the-cart-icon) and Side Cart with the most recent cart data.

The `refreshCart()` function returns a Promise that resolves when the latest cart data is retrieved, and the cart UI elements are refreshed.

> **Note:** Calling the `refreshCart()` function will trigger the [`onCartChange()`](/wix-ecom-frontend/on-cart-change) event handler.

import wixEcomFrontend from 'wix-ecom-frontend';
import wixEcomBackend from 'wix-ecom-backend';

$w('#myAddAndRefreshCartButton').onClick(() => {

  // example values for the options object
  const options = {
    lineItems: [{
      catalogReference: {
        // Wix Stores appId
        appId: '215238eb-22a5-4c36-9e7b-e7c08025e04e',
        // Wix Stores productId
        catalogItemId: '3fb6a3c8-988b-8755-04bd-5c59ae0b18ea',
      },
      quantity: 1
    }]
  };

  // The wixEcomBackend.currentCart module is universal.
  // You can call its methods in frontend and backend code.
  wixEcomBackend.currentCart.addToCurrentCart(options)
    .then(() => {
      console.log('item added to cart');
      // refresh the cart after adding item
      wixEcomFrontend.refreshCart();
    })
    .catch((error) => {
      console.error(error);
      // Handle the error
    });
});

Refresh the cart

refreshCart

Fulfilled - When the cart refresh is complete.

# Introduction
Using the eCommerce frontend API, you can interact with the native cart and checkout components on your site.

 With the eCommerce frontend API, you can:
 + Refresh the cart to display its latest state.
 + Listen to changes in the native cart components.
 + Open the Side Cart panel.
 + Navigate to the [Cart Page](https://support.wix.com/en/article/customizing-the-cart-page).
 + Navigate to the [Checkout Page](https://support.wix.com/en/article/customizing-the-checkout-page).

 To use the eCommerce frontend API, import `wixEcomFrontend` from the `wix-ecom-frontend` module:

   ```javascript
   import wixEcomFrontend from 'wix-ecom-frontend';
   ```

 ## Before you begin

 It's important to note the following points before starting to code:

 + You need to [add eCommerce functionality to your site](https://dev.wix.com/docs/rest/business-solutions/e-commerce/wix-e-commerce-platform-handbook/get-started/wix-site-creators-velo-developers-add-e-commerce-functionality-to-a-site).

 + Upgrade your site to a premium business plan in order to [accept payments](https://support.wix.com/en/article/accepting-payments-an-overview).

 ## Terminology

 + **Cart**: Holds information about a potential transaction, including details about selected items, prices, and discounts, as well as the potential buyer.
 + **Side Cart**: A preview of the cart page, which opens as a panel on the side of a page.
 + **Cart Page**: A page where a buyer can view and manage the items in their cart.
 + **Checkout Page**: A page where a buyer finalizes a purchase. Each checkout holds information about the items to be purchased, price and tax summaries, shipping and billing information, any applied discounts, and more.

velo_wix-ecom-frontend

Whether to hide the ["Continue Browsing"](https://support.wix.com/en/article/customizing-links-on-your-cart-page#customizing-the-continue-browsing-links) button from top-right-hand corner of the Checkout Page.

Default: `false`

hideContinueBrowsingButton

boolean

URL to replace the default "Continue Browsing" URL. For example, if you'd like to redirect the customer to your own custom page.

overrideContinueBrowsingUrl

URL to replace the default [Thank You Page](https://support.wix.com/en/article/customizing-the-thank-you-page) URL.

Pass `{orderId}` (not the order ID itself) as a parameter to the URL to dynamically insert the order ID. See the example on the right for more information.

overrideThankYouPageUrl

Whether to skip the delivery details step in checkout. For example, if the product is for pick-up only.

Default: `false`

navigateToCartPage( )