Skip to main content
POST
Adjust Inventory

Adjust Inventory

Adjusts the inventory level for an inventory item by a relative amount. Use a positive number to increase inventory and a negative number to decrease it. The resulting available quantity is clamped at 0 (it never goes negative). The inventory item is matched as a variant first, then as a product (for variant-less products), so inventory_item_id is a variant ID or a product ID.

Request

Body Parameters

string
required
The inventory item ID to adjust (variant ID, or product ID for variant-less products)
number
required
The amount to adjust by (positive to increase, negative to decrease)

Response

Returns the standard response envelope. The data object contains an inventory_level object with the new available quantity.
object
The updated inventory level

Example Response

Error Response

When the inventory item cannot be found:
When required fields are missing: