Passer à la navigation
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.

Paramètres de chemin

product_idstringRequis

En-têtes

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

Requête

This endpoint expects an object.
pricing_modeenumOptionnelPar défaut 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’.

Valeurs autorisées:
intake_questionslist of objectsOptionnel

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 objectsOptionnel

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

ungrouped_rankinteger or nullOptionnel

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

namestringOptionnel
Name of the product.
descriptionstringOptionnel
Description of the product.
pricedouble or nullOptionnel>=0

Price of the product; null for no listed price.

is_activebooleanOptionnel
False hides the product without deleting it.
orderablebooleanOptionnel

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

allowed_fulfillment_typeslist of enumsOptionnel
Fulfillment options customers may choose when ordering this product.
Valeurs autorisées:
location_idslist of stringsOptionnel

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

track_quantitybooleanOptionnel

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.

Réponse

Réponse réussie

namestring
Name of the product.
_idstring
pricing_modeenumOptionnelPar défaut 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’.

Valeurs autorisées:
intake_questionslist of objectsOptionnel

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 objectsOptionnel

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

ungrouped_rankinteger or nullOptionnel>=0

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

descriptionstringOptionnel
Description of the product.
pricedouble or nullOptionnel>=0

Price of the product; null for no listed price.

is_activebooleanOptionnelPar défaut true
False hides the product without deleting it.
orderablebooleanOptionnelPar défaut true

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

allowed_fulfillment_typeslist of enumsOptionnel
Fulfillment options customers may choose when ordering this product.
Valeurs autorisées:
location_idslist of stringsOptionnel

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

stockmap from strings to integers or nullOptionnel

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

created_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

updated_at_unixintegerOptionnel

Unix timestamp (seconds since epoch)

Erreurs

422
Unprocessable Entity Error