Setup

To use the Ecom API, install the @wix/ecom package using npm or Yarn:

Copy
1
npm install @wix/ecom

or

Copy
1
yarn add @wix/ecom

Then import ecom from @wix/ecom:

Copy
1
import ecom from '@wix/ecom'
Was this helpful?
Yes
No

About the Wix eCommerce API

The Wix eCommerce platform is a comprehensive suite of services that addresses standard and specialized needs in online selling.

The platform serves as a foundational layer for Wix's own business solutions, such as Stores, Bookings, and Restaurants Orders. It can also be integrated with external business solutions, enabling customization and flexibility.

The Wix eCommerce API provides developers with a comprehensive set of services for customizing eCommerce functionality on Wix sites. The API empowers developers to extend functionality, create features, and build robust eCommerce solutions that meet the specific needs of their users.

With the Wix eCommerce API, you can do the following and more:

Before you begin

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

  • For an overview of the Wix eCommerce platform and its capabilities, take a look at the Wix eCommerce Platform Handbook.
  • The Wix eCommerce API is constantly being expanded with new capabilities. Check the API reference regularly to stay up to date with new functionality.

Terminology

  • Catalog: A repository containing items for sale. A catalog can contain anything sellable, including physical products, services, gift cards, pricing plans, and custom items created for individual transactions like specialized project work. Wix business solutions, such as Wix Bookings and Wix Stores, provide built-in catalogs.
  • Cart: Once customers have found catalog items they want to purchase, they can add these items to their cart. A cart holds information about a potential transaction, including details about selected items, prices, and discounts, as well as the potential buyer. Site visitors can see their cart on the cart page. Developers can access and manage a customer's cart with the Cart API and the Current Cart API. Some purchasing flows bypass the cart entirely and proceed directly to checkout.
  • Checkout: Checkout is the 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. Developers can access and manage checkout details and trigger checkout-related events with the Checkout API.
  • Order: Once a customer has committed to a purchase, an order is created. An order holds information about purchased items, price and tax summaries, shipping and billing information, any applied discounts, and the status of payment and fulfillment. In the dashboard, business staff can create new orders, view and edit existing orders, track fulfillment, and manage the payments cycle. The Orders API enables apps or site owners to customize management of the order lifecycle, including viewing, editing, approving, canceling, and charging.
Was this helpful?
Yes
No