Naar navigatie springen
ReceptionProducts

Update Product

Update a product’s catalog fields. Only the fields sent are changed. On-hand quantities are not part of this call; use the stock endpoints.

Padparameters

product_idstringVerplicht

Headers

xi-api-keystringOptioneel
xi-workspace-idstring or nullOptioneel
The customer workspace a reseller's API key acts on.

Verzoek

This endpoint expects an object.
pricing_modeenumOptioneelStandaard fixed

‘fixed’ (default): the item has a known price the agent can quote, and customers can book or order it directly. ‘quote’: the price depends on the job (renovation, catering, custom work), so no price or slot is offered; the agent collects the intake_questions and files a quote request instead. Takes effect only while quotes are enabled for the business. Group services cannot use ‘quote’.

Toegestane waarden:
intake_questionslist of objectsOptioneel

Questions the agent asks before booking or ordering this item. Required for a useful pricing_mode='quote' item — without them a quote request arrives with nothing to price — but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment).

groupslist of objectsOptioneel

Group memberships for this item. Each entry carries the group label and the item’s 0-based rank within that group.

ungrouped_rankinteger or nullOptioneel

Display position among items with no group; null sorts last. Change it with the reorder endpoint.

namestringOptioneel
Name of the product.
descriptionstringOptioneel
Description of the product.
pricedouble or nullOptioneel>=0

Price of the product; null for no listed price.

is_activebooleanOptioneel
False hides the product without deleting it.
orderablebooleanOptioneel

False keeps the product listed (callers can ask about it) but not orderable.

allowed_fulfillment_typeslist of enumsOptioneel
Fulfillment options customers may choose when ordering this product.
Toegestane waarden:
location_idslist of stringsOptioneel

Locations where this product is sold; empty list means all locations.

track_quantitybooleanOptioneel

Whether this product is counted. Switching it only changes the mode: turning it on keeps whatever is already on hand, turning it off drops the counts. Use the stock endpoints to change the amounts themselves.

Response

Geslaagde response
namestring
Name of the product.
_idstring
pricing_modeenumOptioneelStandaard fixed

‘fixed’ (default): the item has a known price the agent can quote, and customers can book or order it directly. ‘quote’: the price depends on the job (renovation, catering, custom work), so no price or slot is offered; the agent collects the intake_questions and files a quote request instead. Takes effect only while quotes are enabled for the business. Group services cannot use ‘quote’.

Toegestane waarden:
intake_questionslist of objectsOptioneel

Questions the agent asks before booking or ordering this item. Required for a useful pricing_mode='quote' item — without them a quote request arrives with nothing to price — but also valid on fixed-price items that need extra detail (current hair color before a dye job, allergies before a treatment).

groupslist of objectsOptioneel

Group memberships for this item. Each entry carries the group label and the item’s 0-based rank within that group.

ungrouped_rankinteger or nullOptioneel>=0

Display position among items with no group; null sorts last. Change it with the reorder endpoint.

descriptionstringOptioneel
Description of the product.
pricedouble or nullOptioneel>=0

Price of the product; null for no listed price.

is_activebooleanOptioneelStandaard true
False hides the product without deleting it.
orderablebooleanOptioneelStandaard true

False keeps the product listed (callers can ask about it) but not orderable.

allowed_fulfillment_typeslist of enumsOptioneel
Fulfillment options customers may choose when ordering this product.
Toegestane waarden:
location_idslist of stringsOptioneel

Locations where this product is sold; empty list means all locations.

stockmap from strings to integers or nullOptioneel

On-hand quantity by location. None means unlimited. A missing location key means zero.

created_at_unixintegerOptioneel

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptioneel

Unix timestamp (seconds since epoch)

Fouten

422
Unprocessable Entity Error