Introduction

The eCommerce Products API allows you to manage products to sell.

With the Products API, you can:

• create and update products
• add media, such as images or GIFs, to products

See Managing Products for more information.

Before you begin

To use the Products API, import { products } from the wix-ecom.v2 module:

Terminology

• Options: Property types that customers can select within the specific product. For example, color and size.
• Choices: Available selections within each option. For example, red, green, and blue as choices under the color option.
• Variants: Combinations of different product options and choices. For example, a red shirt in size large.

Permissions Information

The following functions in the Products API are restricted and only run if you elevate permissions using the wix-auth elevate() function:

• addProductMedia()
• addProductMediaToChoices()
• addProductsToCollection()
• createCollection()
• createProduct()
• deleteCollection()
• deleteProduct()
• deleteProductOptions
• removeBrand()
• removeProductMedia()
• removeProductMediaFromChoices()
• removeProductsFromCollection()
• removeRibbon()
• resetAllProductVariantData()
• updateCollection()
• updateProduct()
• updateProductVariants()

Events

Products API events are fired on your site’s backend when certain events occur with products. See wix-stores-backend events for more information related to these events.