eCommerce Quick Start

The SDK ecom module allows you to take advantage of Wix eCommerce services in a site or app you build on any platform. This means you can handle shopping carts and checkout flows for your Wix Store products.

This tutorial shows you how to create a React component with a complete eCommerce flow. The component lists products from a Wix store, allows visitors to add products to a shopping cart, and redirects visitors to a checkout page. The tutorial also demonstrates how to maintain cart sessions.

The tutorial is based on the Wix Headless example site. You can test out the live example site, or fork the site's code repo to use as a starting point for your own site or app.

This implementation focuses on simplicity and understandability, rather than feature richness, performance or completeness. For details about additional functionality, see Wix eCommerce in the API Reference. Looking for a more comprehensive example site integrating Wix Headless APIs for managing an online store? Check out our starter templates.

Implementing the eCommerce flow includes the following steps:

1. Set up the Wix Headless environment.
2. Import the SDK modules and create an SDK client.
3. Create a React component and state variables.
4. Fetch your Wix Store products.
5. Handle the cart session.
6. Implement the checkout flow.
7. Add the useEffect hook.
8. Render the UI.

Step 1: Set up the Wix Headless environment

Before using the SDK, there are a few things you need to set up on your Wix account and in your external site or app's coding environment.

To set up the Wix Headless environment, follow these steps:

1. If you haven't already, create a project.
   When prompted to add functionalities to your new project, select eCommerce.
2. Set up authorization for your site by creating and configuring an OAuth app.
3. Set a domain to be used by Wix-managed pages.
4. Set a domain that Wix can redirect to after completing a Wix-managed process.
5. Install the API client and relevant SDK module packages by running the following commands:
   For NPM:
   Copy

   For Yarn:
   Copy

6. Install the react package to handle UI rendering and the js-cookie package to handle session cookies. Run the following commands:
   For NPM:
   Copy

   For Yarn:
   Copy

Step 2: Import the SDK modules and create an SDK client

The next step is to set up your code file to run the SDK functions. To set up the code file, follow these steps:

1. Add the following import statements to the top of your code file:

   Copy

2. Create an SDK client by adding the following code to your code file. Replace the value for clientId with your OAuth app's client ID. You can find the ID in your project's Headless Settings menu.
   The value for tokens is the 'session' cookie on the visitor's browser. It's used to make calls to the Wix API. This way, you can maintain previous visitor sessions. For information about managing cookies, see Session Token Management.

   Copy

Step 3: Create a React component and state variables

The logic for our eCommerce flow is contained in a React component called Store. To create the component, follow these steps:

1. Add the following function component to your code file:
   Copy

2. Define state variables by adding the following code to the Store component:
   The productList variable stores the list of products from your project's Wix Store. The cart variable stores the current cart session.
   Copy

Step 4: Fetch your Wix Store products

Define a function to fetch your Wix Store products by adding the following code to the Store component. This function runs when the component is first rendered. The function uses the queryProducts() function from the SDK's Stores module to query your store's products.

Step 5: Handle the cart session

Add the following 3 functions for handling cart sessions to the Store component. Each of these functions use functions from the ecom CurrentCart submodule.

1. fetchCart() - Fetches the current cart session, if there is one, using the getCurrentCart() function. Sets the browser's session cookie to the SDK client's current access tokens. fetchCart() runs when the component is first rendered.
   Copy

2. addToCart() - Adds a product to the cart using the addToCurrentCart() function. addToCart() runs when a product rendered in the UI is clicked.
   Copy

3. clearCart() - Clears the current cart session using the deleteCurrentCart() function. clearCart() runs when a Clear Cart button in the rendered UI is clicked.
   Copy

Step 6: Implement the checkout flow

Add a function called createRedirect() to the Store component. This function runs when a Checkout button in the rendered UI is clicked. The function does the following:

1. Uses the createCheckoutFromCurrentCart() function to create a checkout for the products currently in the cart and retrieve a checkoutId.
2. Uses the createRedirectSession() function with the retrieved checkoutId to retrieve an ecom checkout URL. This is the URL for a Wix-managed checkout page that the visitor can use to complete the checkout process.
3. Redirects the browser to the checkout URL. If the checkout is successful, the visitor is redirected to a Wix thank you page. After the thank you page, or if the checkout fails, the visitor is redirected to the URL passed in the postFlowUrl property when calling the createRedirectSession() function.

Notes:

• When redirecting from a Wix checkout page to an external site, Wix validates that the provided redirect URL is registered under an allowed domain for the given client ID. Therefore, you must add your domain to the OAuth app.
• A visitor can choose to log in to your site or app during the Wix checkout process.

Step 7: Add the useEffect hook

Add the following code to the Store component to run the fetchProducts() fetchCart() functions after the component is rendered. This ensures that your product data, any existing cart data, and member data are available when the component mounts.

Step 8: Render the UI

Add the following code to the Store component's return statement to render the UI. The UI displays the following:

• A Choose Products section with a list of your store's products. Clicking a product adds it to the cart.
• A Cart section with a list of the products in the cart.
• A Clear Cart button that clears the current cart session.
• A Checkout button that redirects the visitor to the Wix checkout page.

Complete code example

You can use the following full code example as a starting point for developing your own site: