Catalog - Product modifiers
The Catalog API manages products, categories, brands, bulk pricing rules, and more. To learn more about catalog resources, see the Catalog Overview.
Product modifiers represent choices that the shopper can make to change how the merchant customizes or adds on to the product. Examples include shipping insurance, monograms, custom inseam length, and color selections for unfinished products.
Modifier values do not change which item is picked in a warehouse, but they change what happens to that item between the warehouse shelf and the shopper taking possession of their order.
Critically, modifier values do not change which product variant is fulfilled. You cannot track inventory for combinations of modifier values.
You can add an adjuster to a modifier value to override the underlying product variant’s properties, such as price, weight, and shipping rules. Not all modifier types are compatible with adjusters.
To learn more about authenticating Catalog endpoints, locate the Authentication section at the top of each endpoint, then click Show Details.
Option Values and Configs
Modifiers endpoints include many fields with data that are specific to one or more type values, as different modifier option types have different functionality. This information is contained in the option_values array and the config object. See the tables below for details on the fields available for each modifier type.
Option Values
Modifier types that present choices to the shopper use an option_values array. Each entry defines a possible value for that modifier, along with display text, ordering, and adjusters for price, weight, and more. This is not used for modifier types that do not present choices, including text, multi_line_text, numbers_only_text, date, and file.
Configs
The config object customizes the behavior and validation of a modifier. Available fields depend on the type of modifier, such as text, date, file, or product list. Note that the multiple choice option types (radio_buttons, rectangles, dropdown, swatch) do not have option configs, as they only use fields in the option_values array.
Supported File Types
The file modifier type allows you to restrict the file types that can be uploaded by a shopper by setting the file_types_mode to specific. You can then use the file_types_supported and file_types_other arrays to specify the allowed file types. The following file types are supported:
Resources
Webhooks
Learn more about Product webhook events.
