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

Commerce

updateAddOn

Update Add-On

Edit ONE add-on (modifier) in place: name, price delta, required flag, availability, order, or its group (modifierListName / selectionType).

write

Arguments

• appIdstringrequiredThe Studio app ID whose catalog to edit.
• addOnIdstringrequiredThe add-on ID to edit.
• namestringoptionalNew add-on name.
• priceMinorintegeroptionalNew price delta in minor units.
• requiredbooleanoptionalWhether a selection is required.
• maxQuantityintegeroptionalMax quantity per line.
• isAvailablebooleanoptionalAvailability.
• orderintegeroptionalDisplay order.
• modifierListNamestringoptionalGroup label this add-on belongs to.
• 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.

• change the candles add-on to $4
• make the filling choice required
• rename this add-on

Pair it with

The verbs that finish the job.

• getProductRelations
• createAddOn