About the Customizations API

The Customizations API allows you to create and manage product customizations, which include options and modifiers. These can be applied to products to allow customers to customize, select a specific product variant, or add on to a product.

Customizations can be either options or modifiers:

• Options create product variants that affect inventory, SKU, and pricing. For example, a "Size" option with "Small", "Medium", "Large" choices creates three variants.
• Modifiers collect additional information from customers without creating variants. For example, a "Gift Message" modifier allows customers to enter text.

For a comprehensive explanation of options, modifiers, and variants, see About Product Options and Variants.

With the Customizations API, you can:

• Create and manage reusable customizations.
• Retrieve information about existing customizations.
• Delete existing customizations.

Customizations and products

Customizations can be created independently and then assigned to products, or they can be created inline when creating a product. When you create a product with inline options or modifiers (without referencing existing customization IDs), new standalone customization entities are automatically created, which can then be reused across other products.

Deleting customizations

Options and modifiers have different deletion behavior:

• Options can't be deleted while assigned to any product, because they affect product variants and inventory.
• Modifiers can be deleted freely. When a modifier is deleted, it's automatically removed from all products that reference it.

Deleting choices

Choices within options can't be removed if they're assigned to one or more product variants. Choices within modifiers can be removed freely.

Before you begin

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

• The Wix user must install the Wix Stores app.

Use cases

• Set up customizations for a clothing store
• Create a product with new options
• Create a product with new modifiers

Terminology

For a comprehensive glossary of Catalog V3 terms, see Terminology.