Skip to content
ShopentlyLearn

Inventory

Read stock and apply controlled adjustments, sales limits and manual reservations.

Operations

GETList stock records/api/v1/inventory/stock

POSTCreate a stock adjustment/api/v1/inventory/stock-adjustments

GETGet a stock record/api/v1/inventory/stock/{stock_id}

PATCHUpdate a stock record/api/v1/inventory/stock/{stock_id}

PATCHUpdate a manual reservation/api/v1/inventory/stock/{stock_id}/manual-reservation

PATCHUpdate a sales limit/api/v1/inventory/stock/{stock_id}/sales-limit

How it works

Stock records distinguish physical on_hand quantity, order reservations, manual reservations and the quantity available for sale. Use the returned stock identifier and version; product and variant stock are separate targets.

A sellable_limit of -1 means unlimited, while 0 means no available sales. Unlimited availability is exposed as null in available. Do not treat null as zero. Stock adjustments, sales limits and manual reservations use separate operations and permissions.

Examples

Guides

How to adjust stock