Adjustments & Transfers
Get Inventory Adjustment
Retrieve a single inventory adjustment by ID. Loads fifoLayers and required list view relations.
Update Inventory Adjustment
Update an existing inventory adjustment.
Delete Inventory Adjustment
Delete an inventory adjustment. Reverses the inventory movement. Will fail if doing so would result in negative fulfilled quantities.
Create Inventory Adjustment
Create a new inventory adjustment. Supports increase, decrease, and set adjustment types.
Bulk Delete Inventory Adjustments
Bulk delete multiple inventory adjustments by ID, or delete all matching current filters.
List Inventory Adjustments
List all inventory adjustments. Supports filtering, sorting, search and pagination.
Bulk Archive Inventory Adjustments
Bulk archive multiple inventory adjustments.
Bulk Unarchive Inventory Adjustments
Bulk unarchive multiple inventory adjustments.
Archive Inventory Adjustment
Archive a single inventory adjustment.
Unarchive Inventory Adjustment
Unarchive a single inventory adjustment.
Check Inventory Adjustments Deletable
Check which inventory adjustments can be deleted. Returns a deletability status for each requested ID.
Get Adjustment Activity Log
Get paginated activity log for a specific inventory adjustment. Includes who made the change and what changed.
List Allocations
Returns a paginated list of inventory allocations.
Get Allocation
Returns a single inventory allocation by ID.
Reorder Allocation
Reorders an allocation relative to another.
Reassign Coverage
Manually (re)assigns a single allocation's PO-line coverage. Binding a PO line transitions the allocation to `AwaitingReceipt` and pins it as tight coverage (so a later automatic rebalance won't move it).
Get Move Targets
Lists the candidate destination sales order lines that on-hand (`allocated`) stock from this allocation can be moved to.
Move To Line
Moves on-hand (`allocated`) stock from this allocation to a backordered line in the same product + warehouse pool — a **conserved swap**.
List Pull-Stock Donors
Lists the sales order lines a backordered line can pull on-hand stock from. Returns other sales orders holding **soft** allocations (`allocated`, not yet committed to a printed shipping label) of the same product in the same warehouse pool, excluding the backordered line's own sales order.
Pull Stock To Line
Pulls soft on-hand stock from one or more donor sales order lines onto a backordered line, atomically. Each donor's soft allocation is backordered by the pulled quantity and the freed on-hand is allocated to the destination line — a **conserved swap** that preserves total demand and FIFO cost layering across every affected order. All pulls succeed or roll back together.
Reserve Allocation to Bin
Hard-reserve an allocation's stock to a specific bin so it's held there for its order and picked from there.
Clear Bin Reservation
Clear an allocation's hard bin reservation.
List Backorders
Returns a paginated backorder queue showing allocations that are awaiting stock.
Search Backorders
Returns the same paginated list of backorders as the GET version of this endpoint, but accepts filters as a JSON request body instead of the query string. Use this POST variant when the filter set is too large or too complex to fit in a URL.
Export Backorders
Downloads the backorder queue as an XLSX or CSV file.
Get Summary
Returns summary statistics for inventory allocations — total counts by status, total quantities, coverage metrics.
Get Breakdown
Returns a breakdown of allocations grouped by relevant dimensions (warehouse, supplier, status) for dashboard widgets.
Get Product Analysis
Returns allocation analysis for a specific product — current allocations, coverage status, and demand history.
Get Supplier Analysis
Returns allocation analysis for a specific supplier — coverage metrics, pending PO quantities, backorder exposure.
List Coverage Options
Lists the open PO lines a product's allocation can be manually covered by — used to populate the 'Change PO Coverage' picker.
List Allocation Suppliers
Returns a list of suppliers that have active inventory allocations — used to populate supplier filter dropdowns.
Search Allocation Suppliers
Searches suppliers by name for autocomplete dropdowns. Returns suppliers that match the query string.
Export Allocations
Downloads an export of inventory allocations.
Sync Coverages
Dispatches a background job to sync allocation coverages. Returns a `tracked_job_log_id` for monitoring progress via the tracked job log endpoints.
Rebalance Coverages
Dispatches a background job that rebalances allocation coverages — it tears down every non-tight `AwaitingReceipt` coverage and rebuilds it from scratch using the current resolved PO ETAs (inbound-shipment expected arrival, falling back to the PO header's estimated delivery date).
Release Allocations
Dispatches a background job to release eligible allocations to fulfillment. Returns a `tracked_job_log_id` for monitoring progress via the tracked job log endpoints.
Reset Priorities
Dispatches a background job to reset allocation priorities using the specified method.
Compact Priorities
Dispatches a background job to compact allocation priority numbers — fills in gaps from deleted/cancelled allocations so priorities are sequential. Returns a `tracked_job_log_id`.
Evaluate Releases
Dispatches a background job to evaluate which allocations are ready for release.
Check Release Availability
Checks whether the specified allocations have sufficient stock to be released. Returns availability status per allocation.
Release Selected Backorders
Immediately releases the specified allocations to fulfillment.
Submit Fulfillments
Submits fulfillments for the specified released allocations.
Delete Fulfillments
Deletes pending fulfillments for the specified allocations, reverting them to released status.
Unreserve Allocations
Cancels (unreserves) the specified allocations.
Switch Supplier Options
Returns the per-allocation supplier picker payload used by the Allocation Pipeline Change Supplier dialog. Only allocations in `planned` or `awaiting_receipt` status are eligible. For each eligible allocation, returns the list of suppliers configured for that product (via `supplier_products`), excluding archived suppliers.
Switch Suppliers
Bulk updates the supplier on one or more inventory allocations. Each assignment is validated against `supplier_products` so the chosen supplier must already be configured for the allocation's product. Allocations not in `planned` or `awaiting_receipt` status are skipped.
Create Warehouse Transfer
Creates a warehouse transfer (in draft status) moving stock between two warehouses.
Bulk Delete Warehouse Transfers
Deletes multiple warehouse transfers, reversing their inventory movements. Provide either ids (array of transfer IDs) or apply_to_all=true with an optional filters object.
Update Warehouse Transfer
Updates a warehouse transfer. Accepts the same fields as Create Warehouse Transfer (all optional) plus tags (array of tag names to sync). The products array replaces the transfer's line items; include existing line ids to keep them.
Delete Warehouse Transfer
Deletes a warehouse transfer and reverses its inventory movements. Deletion fails when received stock from this transfer has already been consumed downstream (sold, transferred again, or adjusted).
Duplicate Warehouse Transfer
Creates a new draft warehouse transfer copying the source transfer's warehouses and line items.
List Warehouse Transfers
Returns a paginated list of warehouse transfers.
Search Warehouse Transfers
Returns the same paginated list of warehouse transfers as the GET version of this endpoint, but accepts filters as a JSON request body instead of the query string. Use this POST variant when the filter set is too large or too complex to fit in a URL. The response includes an `unfiltered_total` alongside the standard paginator totals so clients can show both the filtered and total record counts.
Get Warehouse Transfer
Returns the full detail view of a warehouse transfer.
Get Tab Counts
Returns badge counts for all detail page tabs in a single request — line items, shipments, receipts, inventory movements, FIFO layers, allocations, activity log. Used to populate tab badges without loading each tab's full data.
Browse Products
Searches products that can be added to this warehouse transfer. Scoped to the transfer's `from_warehouse`.
Get Line Items
Returns the line items for a warehouse transfer, including product details, quantities, shipped/received quantities, and COGS values.
Get Inventory Movements
Returns paginated inventory movements generated by this warehouse transfer (both ship-out and receive-in movements).
Get FIFO Layers
Returns the FIFO inventory layers for this warehouse transfer (paginated).
Get Product Cost Composition
Returns the per-component cost composition of a product's weighted-average unit cost — how much each consumed component (and any landed-cost or labor category) contributes to the average unit cost. Useful for manufactured or assembled goods to see what makes up the final cost, not just the blended number.
Get Allocations
Returns inventory allocations linked to this warehouse transfer.
Generate Accounting Transactions
Generates or regenerates accounting transactions (financial lines) for this warehouse transfer based on the current COGS data.
Create Receiving Discrepancy
Creates a receiving-discrepancy accounting transaction for a warehouse transfer, recording the financial gain/loss from the difference between expected and received quantities.
Get Transfer Activity Log
Returns paginated activity log entries for a warehouse transfer.
Download Lines Import Template
Downloads a multi-sheet XLSX template for the warehouse transfer lines bulk import.
Import Warehouse Transfer Lines
Imports line items into an existing warehouse transfer from CSV data. Provide either file (a stored upload reference) or csvString (inline CSV content). The CSV must contain a sku column; quantity is optional and defaults to 1. Rows with the same SKU are merged and quantities summed.
Export Warehouse Transfers
Download warehouse transfers as an XLSX or CSV file. Requires export permission for warehouse transfers.
Get Warehouse Transfer Filter Options
Returns the list of warehouses available for filtering warehouse transfers, as id/name pairs (Amazon FBA, virtual, and supplier warehouses are excluded, and archived warehouses are omitted). Use it to populate the warehouse filter dropdowns on the transfers list.
Create Shipment
Creates a shipment for an already-open traditional (non-Amazon FBA) warehouse transfer. This is the explicit second step of the split lifecycle: open the transfer first (allocations only), then ship.
Get Shipment Detail
Returns the detail view of a specific warehouse transfer shipment, including shipment lines and any associated receipts.
Preview Shipment Line Quantity Change
Preview the inventory implications of changing a warehouse transfer shipment line's quantity, without persisting any change.
Update Shipment Line Quantity
Update a warehouse transfer shipment line's quantity in place, scaling its inventory movements at the source (active negative) and destination (in-transit positive) accordingly.
Get Shipment Activity Log
Returns paginated activity log entries for a specific shipment.
Get Shipment Inventory Movements
Returns paginated inventory movements scoped to the given warehouse transfer shipment. Movements are linked to the shipment's `WarehouseTransferShipmentLine` records (negative inventory events — stock leaving the source warehouse). Includes movement type, quantity, FIFO layer link, unit/total cost, and product/warehouse references for each movement. Used by the Movements tab on the shipment detail page.
Delete Warehouse Transfer Shipment
Deletes a shipment from the warehouse transfer, reversing its stock deduction at the source warehouse and returning the shipped quantities to available stock. Returns the updated transfer.
List Warehouse Transfer Receipts
Returns all shipment receipts recorded against the warehouse transfer, including receipt lines with received quantities and the units still pending per shipment line.
Get Receipt Detail
Returns the detail view of a specific warehouse transfer receipt, including receipt lines. Automatically detects lines that generated blemished inventory adjustments.
Preview Receipt Line Quantity Change
Preview the implications of changing a warehouse transfer receipt line quantity without persisting any changes.
Update Receipt Line Quantity
Update a warehouse transfer receipt line's quantity. The shipment line and warehouse transfer line are NOT mutated by this edit — they remain canonical intent.
Get Receipt Activity Log
Returns paginated activity log entries for a specific receipt.
Get Receipt Inventory Movements
Returns paginated inventory movements scoped to the given warehouse transfer receipt. Includes movement type, quantity, FIFO layer link, unit/total cost, and product/warehouse references for each movement. Used by the Movements tab on the receipt detail page.
Get Receipt FIFO Layers
Returns paginated FIFO layers created by the given warehouse transfer receipt. Each layer includes original/available quantity, average unit cost, total cost, polymorphic source link, and product/warehouse references. Used by the FIFO Layers tab on the receipt detail page.
Receive Warehouse Transfer Shipment
Records a receipt against a shipped warehouse transfer, adding the received quantities to stock at the destination warehouse.
Update Warehouse Transfer Receipt
Updates a previously recorded receipt, adjusting received quantities.
Delete Warehouse Transfer Receipt
Deletes a receipt from the warehouse transfer, removing the received stock from the destination warehouse.
Open Warehouse Transfer
Opens a draft warehouse transfer, making it active. Opening validates that the transfer has line items and allocates stock at the source warehouse.
Revert Warehouse Transfer to Draft
Reverts an open warehouse transfer back to draft status, releasing allocated stock.
Close Warehouse Transfer Draft
Closes a draft warehouse transfer, marking it closed without moving any stock.
Mark Warehouse Transfer as Shipped
Marks an Amazon FBA inbound warehouse transfer as shipped, recording the shipment with Amazon inbound processing (including shortage handling and status updates).
Update Warehouse Transfer Shipment Details
Updates the shipped date and tracking number of an Amazon FBA warehouse transfer after it has been shipped.
Send Warehouse Transfer ASN
Sends (or resends) an Advance Shipment Notice email for the transfer to its destination third-party logistics (3PL) warehouse.
Archive Warehouse Transfer
Archives a warehouse transfer, hiding it from active listings.
Unarchive Warehouse Transfer
Restores an archived warehouse transfer to active status.
Bulk Archive Warehouse Transfers
Archives multiple warehouse transfers. Provide either ids (array of transfer IDs) or apply_to_all=true with an optional filters object to target all transfers matching the current listing filters.
Bulk Unarchive Warehouse Transfers
Restores multiple archived warehouse transfers. Provide either ids (array of transfer IDs) or apply_to_all=true with an optional filters object.
Check Warehouse Transfers Deletable
Checks whether the given warehouse transfers can be deleted. Each result includes deletable (boolean) and reason (why deletion is blocked, or null). A transfer is not deletable when stock it received has already been consumed downstream.
List Warehouse Transfer Notes
Returns the transfer's notes with their authors, newest first, paginated.
Add Warehouse Transfer Note
Adds a note to the warehouse transfer. Fields: note (required).
Toggle Warehouse Transfer Note Pin
Pins or unpins a note on the warehouse transfer. Pinned notes surface at the top of the notes list.
Delete Warehouse Transfer Note
Deletes a note from the warehouse transfer.
Create Warehouse Transfer Bill
Creates a supplier bill linked to the warehouse transfer, capturing third-party costs such as freight.
Get Warehouse Transfer Bill
Returns a bill linked to the warehouse transfer. Responds 404 when the bill does not belong to this transfer.
Update Warehouse Transfer Bill
Updates a bill linked to the warehouse transfer.
List Location Transfers
Paginated history of location transfers (put-aways and relocations).
Create Location Transfer
Execute a location transfer atomically: the document is created, completed, and paired reclassification inventory movements are written per line (-quantity at the from-location, +quantity at the to-location) in a single transaction. Location transfers never affect costing or warehouse-level availability.
Get Location Transfer
Retrieve a single location transfer with its lines. Each line includes the product and the from/to locations.
Get Put-Away Queue
Paginated put-away queue: stock with a positive balance sitting in put-away-from locations (staging, returns, quarantine, damaged) — plus the Unassigned location when include_unassigned is truthy (default). Each row is decorated with the product's suggested destination bin (its preferred default storage location for the warehouse, when one is set and not deprecated).