Inventory
List Faire Inventory
**Legacy** — prefer the per-instance route `GET /api/faire/instances/{integrationInstance}/inventory`.
Get Faire Inventory Summary (Legacy)
**Legacy** — prefer the per-instance route `GET /api/faire/instances/{integrationInstance}/inventory/summary`.
Push Inventory to Faire
Push current inventory levels from the linked warehouse to Faire.
Refresh Inventory Snapshot
Refresh the local inventory snapshot by pulling current inventory levels from the Faire API.
List Forecast Configurations
Lists all forecast configurations (no pagination). Each item includes a `schedules_count` field for the number of automation schedules referencing it.
Create Forecast Configuration
Creates a new forecast configuration.
List Forecast Configurations (Paginated)
Returns paginated forecast configurations.
Get Forecast Configuration
Returns a single forecast configuration with `created_by`, `updated_by`, and `pricing_tier` relationships eager-loaded, plus the `schedules_count` of automation schedules referencing it.
Update Forecast Configuration
Updates an existing forecast configuration. All fields use `sometimes` validation — only send the fields you want to change.
Delete Forecast Configuration
Soft-deletes a forecast configuration.
Duplicate Forecast Configuration
Creates a copy of an existing forecast configuration.
Check Forecast Configuration Usage
Returns whether the configuration is referenced by any automation schedules and the count.
Show My Default Configuration
Get the current user's default forecast configuration, if one has been set.
Clear My Default Configuration
Unset the current user's default configuration. Subsequent visits to demand planning load with a blank slate.
Set as My Default Configuration
Mark this configuration as the current user's default. The default is loaded automatically in the demand-planning UI on page load.
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 inventory from a hold. Supports both partial and full release.
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.