Skip to main content
The Inventory API gives you real-time visibility into stock levels across all your locations, and lets you update quantities and record stock movements programmatically. Use it to sync inventory from warehouse management systems, trigger reorder workflows when stock runs low, or reconcile counts after physical stock takes.
Inventory adjustments are permanent and cannot be undone through the API. Every adjustment is written to the store’s audit log with a timestamp, the user or API key that made the change, and the reason you provide. Review adjustments carefully before submitting them.
Query GET /inventory?low_stock=true to retrieve only variants whose inventory has fallen below your configured reorder threshold. Subscribe a webhook to this query pattern or poll it on a schedule to build automated reorder alerts without scanning your entire catalog.

The Inventory Level Object

string
The ID of the product variant this inventory record belongs to.
string
The SKU of the variant.
string
The ID of the location (warehouse, store, or fulfillment center) holding this stock.
string
Human-readable name of the location.
integer
Current on-hand quantity at this location.
integer
Quantity reserved for open, unfulfilled orders at this location.
integer
Quantity available for new orders (quantity minus reserved_quantity).
string
ISO 8601 timestamp of the last inventory update for this record.

List Inventory Levels

Retrieve inventory levels across all variants and locations. Use filters to narrow results to a specific location, SKU, or low-stock items. GET /inventory
string
Filter results to inventory held at this location ID only.
string
Filter to the variant with this exact SKU value.
boolean
Set to true to return only variants whose available quantity is at or below your store’s configured reorder threshold.
integer
Number of records to return per page. Defaults to 20. Maximum is 100.
integer
Page number to retrieve. Defaults to 1.
Response

Get Inventory for a Variant

Retrieve inventory levels for a single variant across all locations. GET /inventory/:variant_id
string
required
The unique ID of the product variant.
Response

Update Inventory Quantity

Set the on-hand quantity for a variant at a specific location. Use this to sync a verified count from your warehouse system. This call sets an absolute quantity — use the POST /inventory/adjust endpoint if you need to record a relative delta with a reason. PATCH /inventory/:variant_id
string
required
The unique ID of the variant whose inventory you are updating.
string
required
The ID of the location at which to update the quantity.
integer
required
The new absolute on-hand quantity. Must be zero or greater.
Response

Create a Stock Adjustment

Record one or more relative inventory movements at a location. Each item in the adjustment specifies a variant_id, a delta (positive to add stock, negative to remove it), and a reason. All items in the request are applied atomically. POST /inventory/adjust
string
required
The ID of the location where the stock movement occurred.
array
required
An array of stock movement objects. Each item must include variant_id, delta, and reason.
Response

Error Handling

The Inventory API uses standard HTTP status codes. All error responses include a JSON body with a code field and a human-readable message.