1. Docs
2. /
3. Tool reference
4. /
5. Commerce
6. /
7. createAddOn

Commerce

createAddOn

Add Add-On

Attach ONE add-on (modifier) to a product: e.g.

write

Arguments

• appIdstringrequiredThe Studio app ID whose catalog to edit.
• productIdstringrequiredThe product ID to attach the add-on to.
• namestringrequiredAdd-on name, e.g. 'Chocolate' or 'Add candles'.
• priceMinorintegerrequiredAdd-on price delta in minor units, e.g. 300 = +$3.00. 0 = free.
• requiredbooleanoptionaltrue forces a selection from this add-on's group. Defaults false.
• maxQuantityintegeroptionalMax quantity of this add-on per line.
• isAvailablebooleanoptionalfalse hides the add-on. Defaults true.
• orderintegeroptionalDisplay order within the product's add-ons. Defaults 0.
• modifierListNamestringoptionalGroup label this add-on belongs to, e.g. 'Filling'.
• selectionTypestringoptionalModifier group selection: 'single' = pick exactly one (radio), 'multiple' = pick any number (checkboxes).

Returns

The registry does not declare a return shape.

Declared limits

• priceMinor: minimum 0
• priceMinor: maximum 9007199254740991
• maxQuantity: greater than 0
• maxQuantity: maximum 9007199254740991
• order: minimum -9007199254740991
• order: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

• add a candles add-on for $3
• add a gluten-free swap
• add a filling choice: chocolate or vanilla

Pair it with

The verbs that finish the job.

• getProductRelations
• updateAddOn
• deleteAddOn