The Customization API allows creating and managing customizations, which include options and modifiers, which later will be applied to products, for customer’s customizes or adds on to the product.
Options are meant to add variations to a product which required inventory, where modifiers allow users to collect additional information per product from customers without creating variants affecting inventory.
Options and modifiers can be defined together on one product. The options will create variants that may be customized by the customer.
With the Customization API, you can manage your site's customizations:
- Create and manage a bank of Customizations.
- Update entire Customizations or just specific fields.
- Delete existing Customizations.
- Retrieve information about existing customization.
It’s important to note the following points before starting to code:
- The Customizations V3 API is only available for use with the Stores Catalog V3.
- You must call
getCatalogVersion() to get the site's Stores catalog version before using any of the Customizations V3 API methods. If the site uses Stores Catalog V1, the Customizations V3 API methods will not be available.
- Customizations are property types that customers can select within the specific product - e.g., Color and Size.
- If customization affects inventory, sku and so on we call such customization Option. Those Options are basically the product's variants. For example, a T-shirt with two Color Options: red and blue. Each has its own price, sku and inventory tracking.
- If customization does not affect inventory and sku, we call such customization Modifier. Having a modifier will not affect the variants that will be sent to the customer, but it will add specific customization to it.
For example if you sell ice cream and allow to select one of different toppings: vanilla, caramel or chocolate - each is a choice of the toppings Modifier. It has no effect on ice cream in stock.
- Choices are the available selections within each customization - e.g., Red and Green choices under the Color option customization.
CHOICE_TEXT - The corresponding choice type for Text Choices.ONE_COLOR - The corresponding choice type for Swatch Choices. Also includes a parameter for the relevant color hex value.
- CustomizationRenderType is the type of the option or modifier, which needs to match for every choice used:
- TextChoices - Choices that are text based (e.g., "small", "medium", "large"). Needs to be matched with
CHOICE_TEXT choices.
- SwatchChoices - Choices that are colors. Needs to be matched with
ONE_COLOR choices.
- FreeText - Enables entering of free text without giving predefined choices of the customization. Only usable for a Modifier (not an Option).
- Variant: A specific product variation determined by the combination of selected options (e.g., a red, M sized T-shirt).