Configuration

With the Product Restrictions service plugin integrated into your app, Wix will retrieve the product restriction configurations you provide whenever it calls a catalog of products from your app. Follow these steps to add the service plugin and enable Wix to communicate with your app.

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

  2. Click + Create Extension in the top right.

  3. Find Product Restrictions Provider and click + Create.

  4. Use the JSON editor to create the extension's configuration file. Configure the parameters by referencing the table below or the Documentation section to the right of the editor.

NameTypeDescription
deploymentUristringBase URI of the service plugin implementation. Since no method calls this path, it can be left blank.
componentNamestringA unique name for this component. This is an internal name that will only appear in the app dashboard.
productRestrictionsConfigobjectObject that contains product fields to restrict. See below for more details about nested fields.
prices.restrictionLevelenumAffected fields:
  • variantsInfo.variants.price.actualPrice.amount
  • variantsInfo.variants.price.compareAtPrice.amount
options.restrictionLevelenumAffected fields: options (all nested fields except linkedMedia)
modifiers.restrictionLevelenumAffected field: modifiers (all nested fields except linkedMedia)
inventory.restrictionLevelenumAffected fields:
  • variantsInfo.variants.sku
  • variantsInfo.variants.barcode
  • inventory.trackingMethod.quantity
preOrder.restrictionLevelenumAffected fields: inventory.preorderInfo
duplicateProduct.restrictionLevelenumWhether to block product duplication or display a warning when duplicating a product.
  1. Click Test Your App.

Understanding Restriction States

Each restriction can be set to one of the enum values: LOCKED or WARNING. These restrictions apply to all products in the Wix Stores dashboard.

  • LOCKED: Users cannot edit any product fields.
  • WARNING: Users can modify product fields. However, a warning message will notify them of possible complications like synchronization errors. After acknowledging the warning, the fields can be edited normally.
Did this help?