Setup

To use the ProductsV3 API, install the @wix/stores package using npm or Yarn:

Copy

or

Copy

Then import { productsV3 } from @wix/stores:

Copy
Did this help?

bulkAddInfoSectionsToProducts( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds info sections to multiple products.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productsArray<V3ProductIdWithRevision>Required

List of product IDs and revisions.

optionsBulkAddInfoSectionsToProductsOptions
Returns
Return Type:Promise<V3BulkAddInfoSectionsToProductsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkAddInfoSectionsToProductsByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds info sections to multiple products, given the provided filter and search expression.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
filterRecord<string, any>Required

Filter object.

optionsBulkAddInfoSectionsToProductsByFilterOptions
Returns
Return Type:Promise<V3BulkAddInfoSectionsToProductsByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkAddProductsToCategoriesByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adds multiple products, given the provided filter and search expression, to up to 5 categories.

Learn more about the Categories API.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Category item write
Category write
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsBulkAddProductsToCategoriesByFilterOptions
Returns
Return Type:Promise<BulkAddProductsToCategoriesByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkAdjustProductVariantsByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Adjusts the price and cost of multiple variants, given the provided filter and search expression.

Only the following variant fields can be increased/decreased by amount or percentage:

  • basePrice
  • salePrice
  • cost
  • salePriceFromBasePrice
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
filterRecord<string, any>Required

Filter object.

optionsBulkAdjustProductVariantsByFilterOptions
Returns
Return Type:Promise<BulkAdjustProductVariantsByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkCreateProducts( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates up to 100 products.

Note: The following limits apply to the total number of creatable entities in a single request. For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options. Alternatively, you can create 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.

  • options: 100
  • modifiers: 100
  • infoSections: 100
  • variantsInfo.variants: 1000
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productsArray<V3Product>Required

List of products to create.

optionsBulkCreateProductsOptions
Returns
Return Type:Promise<BulkCreateProductsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkCreateProductsWithInventory( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates up to 100 products, and can create the products' inventories in the variants' default locations.

Note: The following limits apply to the total number of creatable entities in a single request. For example, you can create 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options. Alternatively, you can create 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.

  • options: 100
  • modifiers: 100
  • infoSections: 100
  • variantsInfo.variants: 1000
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Manage Restaurants - all permissions
Inventory write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productsArray<ProductWithInventory>Required

List of products to create with inventory.

optionsBulkCreateProductsWithInventoryOptions
Returns
Return Type:Promise<BulkCreateProductsWithInventoryResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkDeleteProducts( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes multiple products.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productIdsArray<string>Required

IDs of products to delete.

Returns
Return Type:Promise<V3BulkDeleteProductsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkDeleteProductsByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Delete multiple products, given the provided filter.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
filterRecord<string, any>Required

Filter object.

optionsBulkDeleteProductsByFilterOptions
Returns
Return Type:Promise<V3BulkDeleteProductsByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkRemoveInfoSectionsFromProducts( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Removes info sections from multiple products.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productsArray<V3ProductIdWithRevision>Required

List of product IDs and revisions.

optionsBulkRemoveInfoSectionsFromProductsOptions
Returns
Return Type:Promise<V3BulkRemoveInfoSectionsFromProductsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkRemoveInfoSectionsFromProductsByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Removes info sections from multiple products, given the provided filter and search expression.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
filterRecord<string, any>Required

Filter object.

optionsBulkRemoveInfoSectionsFromProductsByFilterOptions
Returns
Return Type:Promise<V3BulkRemoveInfoSectionsFromProductsByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkRemoveProductsFromCategoriesByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Removes multiple products, given the provided filter and search expression, from up to 5 categories.

Learn more about the Categories API.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Category item write
Category write
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsBulkRemoveProductsFromCategoriesByFilterOptions
Returns
Return Type:Promise<BulkRemoveProductsFromCategoriesByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkUpdateProductVariantsByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a variant of multiple products, given the provided filter and search expression.

Only the following variant fields can be updated:

  • visible
  • price
  • revenueDetails.cost
  • physicalOptions
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
filterRecord<string, any>Required

Filter object.

optionsBulkUpdateProductVariantsByFilterOptions
Returns
Return Type:Promise<BulkUpdateProductVariantsByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkUpdateProducts( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates up to 100 products.

Note: The following limits apply to the total number of updatable entities in a single request. For example, you can update 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options. Alternatively, you can update 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.

  • options: 100
  • modifiers: 100
  • infoSections: 100
  • variantsInfo.variants: 1000
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productsArray<V3MaskedProduct>Required

List of products to update.

optionsBulkUpdateProductsOptions
Returns
Return Type:Promise<BulkUpdateProductsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkUpdateProductsByFilter( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates multiple products, given the provided filter.

To update infoSections, brand or ribbon fields, you must also pass their existing id.

Note: The following fields cannot be updated with this endpoint:

  • slug
  • options
  • modifiers
  • variantsInfo

To update these fields, use Bulk Update Products.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsBulkUpdateProductsByFilterOptions
Returns
Return Type:Promise<V3BulkUpdateProductsByFilterResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

bulkUpdateProductsWithInventory( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates up to 100 products, and can update the products' inventories in the variants' default locations.

Note: The following limits apply to the total number of updatable entities in a single request. For example, you can update 10 products with up to 10 options for each product (10 x 10 = 100), or one product with 100 options. Alternatively, you can update 100 products with up to 10 variants in each (100 x 10 = 1000), or one product with 1000 variants.

  • options: 100
  • modifiers: 100
  • infoSections: 100
  • variantsInfo.variants: 1000
Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Manage Restaurants - all permissions
Inventory write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productsArray<MaskedProductWithInventory>Required

List of products to update.

optionsBulkUpdateProductsWithInventoryOptions
Returns
Return Type:Promise<BulkUpdateProductsWithInventoryResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

countProducts( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Counts the number of products that match the provided filtering.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Read products in v3 catalog
Product v3 read admin
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsCountProductsOptions
Returns
Return Type:Promise<V3CountProductsResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

createProduct( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a new product.

This endpoint also allows to add a ribbon, brand, info sections, options, and modifiers.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productV3ProductRequired

Product to create.

At least 1 variant must be provided and each variant must have relevant item in choices field for every item in options. If options is empty one default variant must be provided with empty choices list.

optionsCreateProductOptions
Returns
Return Type:Promise<V3Product>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

createProductWithInventory( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a new product, and can create the product's inventory in the variants' default locations.

This endpoint also allows to add a ribbon, brand, info sections, options, and modifiers.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productProductWithInventoryRequired

Product to create with inventory.

At least one variant must be provided and each variant must have relevant item in choices field for every item in options. If options is empty one default variant must be provided with empty choices list.

optionsCreateProductWithInventoryOptions
Returns
Return Type:Promise<CreateProductWithInventoryResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

deleteProduct( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Deletes a product and all its variants.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage v3 catalog
Product write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productIdstringRequired

Product ID.

JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

getProduct( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a product.

Note: To retrieve a non-visible product (visible: false), your app must have the required SCOPE.STORES.PRODUCT_READ_ADMIN permission scope.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Read products in v3 catalog
Product v3 read admin
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
productIdstringRequired

Product ID.

optionsGetProductOptions
Returns
Return Type:Promise<V3Product>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

getProductBySlug( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves a product by slug.

Note: To retrieve a non-visible product (visible: false), your app must have the required SCOPE.STORES.PRODUCT_READ_ADMIN permission scope.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Read products in v3 catalog
Product v3 read admin
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
slugstringRequired

Product slug.

optionsGetProductBySlugOptions
Returns
Return Type:Promise<V3GetProductBySlugResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?