Commerce

`updateProduct`

Update Product

Edit ONE catalog product in place: name, description, base price (in minor units, e.g.

write

Arguments

appIdstringrequiredThe Studio app ID whose catalog to edit.
productIdstringrequiredThe commerce product ID to edit.
namestringoptionalNew product name.
descriptionstringoptionalNew product description.
priceMinorintegeroptionalNew base price in minor units (cents), e.g. 6000 = $60.00.
dietaryTagsstring[]optionalThe product's dietary facts, from the fixed vocabulary: gluten_free, dairy_free, nut_free, peanut_free, tree_nut_free, sesame_free, coconut_free, corn_free, egg_free, soy_free, refined_sugar_free, vegan, vegetarian. REPLACES the whole…
customFieldsobjectoptionalCustom fields to set, merged by key (existing keys you don't pass are kept).
fulfillmentModestringoptionalHow this product is fulfilled. 'in_stock' sells counted stock now, 'made_to_order' uses lead time and ignores count, and 'hybrid' sells on-hand units now then orders ahead on lead time.
leadTimeobjectoptionalThe product lead time in owner-facing units, such as {kind:'days',value:7}.
readyWindowsobject[]optionalOptional local-time ready windows in minutes after midnight, such as [{startMinute:540,endMinute:840}].
zeroInventoryBehaviorstringoptionalLegacy tracked-product policy. Prefer fulfillmentMode; use 'lead_time' only with a positive leadTime or leadTimeMinutes.
leadTimeMinutesintegeroptionalPrep lead time before a pickup slot, in minutes (2880 = 2 days).
lowStockThresholdintegeroptionalProtected inventory floor. Ready-now selling stops at this count.
sellWhenSoldOutbooleanoptionalDeprecated alias for zeroInventoryBehavior: true = 'lead_time', false = 'sold_out'. Prefer zeroInventoryBehavior.
displayQuantitybooleanoptionalWhether storefronts may show the remaining inventory count.
addedLeadDaysintegeroptionalExtra days boxing and chilling add on top of the bake. Absent = the class default (1 ambient, 2 chilled).
parcelBoxKeystringoptionalWhich box carries this product. Absent = the shop's own default box on its shipping location.
shippingClassstringoptionalHow this product travels. Absent = ambient; 'chilled' buys an insulated liner and ice.
shipsbooleanoptionalWhether this product may be shipped at all. Every product ships by default, so pass false for the ones that stay local.

Returns

The registry does not declare a return shape.

Declared limits

priceMinor: minimum 0
priceMinor: maximum 9007199254740991
leadTimeMinutes: minimum 0
leadTimeMinutes: maximum 9007199254740991
lowStockThreshold: minimum 0
lowStockThreshold: maximum 9007199254740991
addedLeadDays: minimum 0
addedLeadDays: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

change the shilajit price to $60
mark the almond cake gluten-free
this one is vegan
make this made to order
when it runs out, keep selling on lead time
sell out when inventory hits zero
tell me when only 3 are left
this cake does not ship
ship this one chilled
fix this product's description

Pair it with

The verbs that finish the job.