Introduction
Some functions in this module are in Developer Preview.
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving these functions. Your feedback is valuable to us.
Note: This module is universal. Functions in this module can run on both the backend and frontend, unless specified otherwise.
The eCommerce Products API allows you to manage products to sell.
With the Products API, you can:
See Managing Products for more information.
Before you begin
To use the Products API, import { products } from the wix-ecom.v2 module:
js | Copy Codeimport { products } from 'wix-stores.v2';
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()
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
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.
Was this helpful?