Skip to main content
POST
Update store product inventory

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The products to update, and the reorder levels or on-hand quantity to write to them.

inventory
object

The change to make to the on-hand quantity. Omit it to update only the reorder levels.

max_stock
string | null

The most of this product the store wants on hand. Send null to clear it; omit it to leave it as it is.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"199.99"

min_par
string | null

The on-hand quantity at which the product should be reordered. Send null to clear it; omit it to leave it as it is.

Pattern: ^-?[0-9]+(\.[0-9]+)?$
Example:

"199.99"

store_product_selection_criteria
object

Criteria used to select products whose inventory will be updated.

Response

The outcome of an inventory update. The updated products are not returned.

updated_count
integer
required

How many products the request updated.