Each product will be assigned with one or more option sets. Each option set can have one or more products as options.
Get all option sets
Get an option set
- An option is a product, so you can find the product details from get a product action.
products_assignedindicates which products have this option set assigned to them.
Create an option set
nameand at least one option is required.
namemust be no longer than 64 characters.
instructionsallows option set selections to include one of the four prefixes:
instructionsis not provided it will default to
max_selectionare both optional. They can be independently or both provided to limit the number of selections in an option.
- If supplied,
0or larger and an integer.
- If supplied,
1or larger and an integer. It must also be equal to or greater than
min_selectionif it is supplied.
optionscontains the products that will be the options.
product_idmust be provided with each option.
- The product must be a valid existing product that is not a variant template.
price_ex_taxis provided it will override the products price only when used as an option in this option set selection. If
price_ex_taxis not provided it will use the company-level product price.
- In all cases the
price_ex_taxis set when the option is created (as part of option set creation). If the product price changes later the option will remain the same price.
- The order in which the
optionsare provided will reflect the order that they will appear on the POS.
Here is a list of the supported webhook topics.
When an option set is created. You will receive the complete option set.
When an option set is updated. You will receive the complete option set after the modifications have been applied.
You also may provide the following attribute filters:
Note that when filtering by
show_online, any changes to
option sets where
show_online is true will trigger a
When an option set is deleted. You will receive the complete option set.