跳到导航
ReceptionProductsStock

Update Product Stock

Set the on-hand quantity of a counted product at one location. Rejected with a 409 if it changed since expected_on_hand was read.

路径参数

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.
location_idstring必需
Location whose count is set.
on_handinteger必需>=0

The new on-hand quantity.

expected_on_handinteger必需>=0

On-hand value the caller last saw. The write is rejected with a 409 if it no longer matches, so a sale made while the caller was editing is never overwritten.

响应

成功响应

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