About the Wix eCommerce Catalog Service Plugin

Important: When developing websites or building apps with Blocks, use Velo service plugins.

The Catalog service plugin lets you become a Wix catalog provider. This means you can integrate any external repository of sellable items with the Wix eCommerce platform. Wix calls the Catalog service plugin to get up-to-date information about items whenever a cart or checkout is updated, and when an item is added to an order.

With the Catalog service plugin, you can:

  • Build a comprehensive business solution offering functionality that differs from Wix's in-house solutions like Wix Stores or Wix Bookings, and integrate your solution with the Wix eCommerce platform to handle transactional capabilities. For example, develop an app to manage equipment rentals, online courses, subscriptions, or vouchers.
  • Integrate an externally managed repository of sellable items with the Wix eCommerce platform to meet specific business needs. For example, if your business handles pricing or availability in a unique way, or if you sell items that aren't easily categorized as physical or digital products or services.
  • Create a Wix app to integrate an existing eCommerce repository on a different platform with Wix's eCommerce platform.

Why an external catalog?

The Catalog service plugin enables you to maintain a complex and dynamic external catalog while being confident Wix can retrieve the latest information for every action.

For example, after a customer adds a particular item to their cart, one of the following details might change in your dynamic catalog:

  • The name of the item might be changed.
  • The price might be adjusted.
  • The item might go out of stock.

With the Catalog service plugin, you can be sure that when the customer moves the item from their cart to their checkout, Wix will retrieve the updated details from your catalog automatically.

Before you begin

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

  • Create a database of items on the platform of your choice.
  • Learn how to handle item variants with the Catalog service plugin.
  • Existing solutions may already provide the catalog functionality that you need. Check out Wix Stores and Wix Bookings, which provide built-in catalogs. If they cater to your needs, you probably don't need to implement the Catalog service plugin.
  • For some items, you might not need an external catalog. Learn more about catalog and custom items.
  • For an overview of the Wix eCommerce platform and its capabilities, take a look at the Wix eCommerce Platform Handbook.
  • We are constantly updating functionality. Check the documentation regularly to see the latest capabilities. Currently, external catalog integration has a few limitations:
    • Coupons aren't yet supported.
    • Preview mode in the Wix editor doesn't reflect full functionality.
    • Integration with external sales channels isn't yet available.

Get started

To integrate an external catalog with the Wix eCommerce platform:

  1. Implement the Get Catalog Items method so Wix can retrieve the information it needs about specific items.

    Note: When Wix calls your app's implementation of the Get Catalog Items method, your app receives a request containing a payload as an encoded JWT.

  2. Create an app in your Wix Studio workspace and add a catalog integration extension.

App Configuration

To enable your Wix app to communicate with your external catalog:

  1. Select an app from the Custom Apps page in your Wix Studio workspace.

  2. Go to Extensions in your app's dashboard.

  3. Click Create Extension.

  4. Scroll down to Ecom Catalog and click Create.

  5. In the JSON editor, assign the URI where the Catalog service plugin is implemented to deploymentUri. For example:

    Copy

    Note: Other fields in the JSON editor are reserved for future functionality.

  6. Click Save.

Terminology

  • Catalog: A repository containing items for sale. Wix business solutions, such as Wix Bookings and Wix Stores, provide built-in catalogs. External business solutions can provide the Wix eCommerce platform with access to their catalogs via the Catalog service plugin. This enables robust integration of the platform’s cart and checkout functionalities with diverse business types.
  • Item: An item in a catalog can be anything sellable, including physical products, services, gift cards, pricing plans, and custom items created for individual transactions like specialized project work.
  • Cart: A customer's 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. When an item is added to a cart, Wix calls the Catalog service plugin to retrieve current details for the item.
  • 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. When an item is added to a checkout, Wix calls the Catalog service plugin to retrieve current details for the item.
  • 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. When an item is added to an order, Wix calls the Catalog service plugin to retrieve current details for the item.

See also

Did this help?