Inventory
Get Inventory Forecast
Returns the inventory forecast for today as a collection of InventoryForecastResource items.
Get Forecast Status
Returns the current forecasting tracking status (e.g., last run time, running state).
Get Forecast Total Cost
Returns total cost metrics for the current forecast.
Refresh Forecast
Triggers a forecast refresh job to recalculate inventory projections.
Create Purchase Orders from Forecast
Create purchase orders from forecast results. Creates a ForecastScheduleRun to track the creation.
Get Fulfillment Debt Report
Returns a paginated list of fulfillment debt lines — sales order lines where fulfilled quantity is less than what was originally ordered.
Get Fulfillment Debt Summary
Returns aggregated summary totals for the fulfillment debt report header cards.
Create Catch-Up Stock Takes
Creates adjustment stock takes in DRAFT status to catch up fulfillment debt.
List Inventory Holds
Returns paginated inventory holds (reservations). By default shows active holds (not released, not expired).
Create Inventory Hold
Creates a single inventory hold (reservation) for a product in a specific warehouse. Deducts from available inventory.
Bulk Create Inventory Holds
Creates inventory holds for multiple products in the same warehouse in a single request. Up to 100 items per request.
Show Inventory Hold
Returns a single inventory hold with full product, warehouse, creator, and releaser details.
Update Inventory Hold
Updates an inventory hold's quantity, notes, or expiration date.
Delete Inventory Hold
Permanently deletes an inventory hold and returns the quantity to available inventory.
Release Inventory Hold
Releases a quantity from an inventory hold, returning it to available inventory.
Bulk Release Inventory Holds
Releases multiple inventory holds at once.
Bulk Delete Inventory Holds
Permanently deletes multiple inventory holds.
Export Inventory Holds
Exports inventory holds as XLSX or CSV file. Columns include: ID, SKU, Product Name, Warehouse, Quantity, Reason, Notes, Created By, Created At, Expires At, Released At, Archived At.
Get Hold Reasons
Returns all distinct non-null reasons used across inventory holds, sorted alphabetically. Useful for populating filter dropdowns.
Get Holds Summary
Returns aggregated summary statistics for inventory holds.
Warehouse Availability
Returns the available inventory for a batch of products in a specific warehouse. Used by the Reserve Stock modal browse drawer.