탐색으로 건너뛰기
ReceptionProductsStock

Adjust Product Stock

Add to or subtract from the on-hand quantity of a counted product at one location, without overwriting orders taken at the same time.

경로 매개변수

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 changes.
deltainteger필수

Signed change to apply to on-hand. Prefer this over an absolute write whenever the intent is ‘a few more/fewer’.

응답

성공 응답

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