नेविगेशन पर जाएँ
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.

पाथ पैरामीटर

product_idstringआवश्यक

हेडर

xi-api-keystringवैकल्पिक
xi-workspace-idstring or nullवैकल्पिक
The customer workspace a reseller's API key acts on.

अनुरोध

This endpoint expects an object.
pricing_modeenumवैकल्पिकडिफ़ॉल्ट: 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’.

अनुमत मान:
intake_questionslist of objectsवैकल्पिक

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 objectsवैकल्पिक

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

ungrouped_rankinteger or nullवैकल्पिक

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

namestringवैकल्पिक
Name of the product.
descriptionstringवैकल्पिक
Description of the product.
pricedouble or nullवैकल्पिक>=0

Price of the product; null for no listed price.

is_activebooleanवैकल्पिक
False hides the product without deleting it.
orderablebooleanवैकल्पिक

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

allowed_fulfillment_typeslist of enumsवैकल्पिक
Fulfillment options customers may choose when ordering this product.
अनुमत मान:
location_idslist of stringsवैकल्पिक

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

track_quantitybooleanवैकल्पिक

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.

रिस्पॉन्स

सफल रिस्पॉन्स

namestring
Name of the product.
_idstring
pricing_modeenumवैकल्पिकडिफ़ॉल्ट: 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’.

अनुमत मान:
intake_questionslist of objectsवैकल्पिक

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 objectsवैकल्पिक

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

ungrouped_rankinteger or nullवैकल्पिक>=0

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

descriptionstringवैकल्पिक
Description of the product.
pricedouble or nullवैकल्पिक>=0

Price of the product; null for no listed price.

is_activebooleanवैकल्पिकडिफ़ॉल्ट: true
False hides the product without deleting it.
orderablebooleanवैकल्पिकडिफ़ॉल्ट: true

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

allowed_fulfillment_typeslist of enumsवैकल्पिक
Fulfillment options customers may choose when ordering this product.
अनुमत मान:
location_idslist of stringsवैकल्पिक

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

stockmap from strings to integers or nullवैकल्पिक

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

created_at_unixintegerवैकल्पिक

Unix timestamp (seconds since epoch)

updated_at_unixintegerवैकल्पिक

Unix timestamp (seconds since epoch)

त्रुटियाँ

422
Unprocessable Entity Error