Warehouses
List Warehouse Locations
List all storage locations defined for a warehouse. The path parameter is the WAREHOUSE ID (not a location ID).
Update Warehouse Location
Update a storage location. All fields are optional — send only the fields to change.
Create Warehouse Location
Create a storage location inside a warehouse.
List Warehouses
Returns all warehouses.
Show Warehouse
Returns a single warehouse.
Create Warehouse
Creates a new warehouse.
Bulk Delete Warehouses
Deletes multiple warehouses. Provide either ids (array of warehouse IDs) or apply_to_all=true with an optional filters object. Warehouses referenced by other records are skipped and counted in failCount. Use Check Warehouses Deletable first to verify which records can be removed.
Update Warehouse
Updates an existing warehouse. Accepts the same fields as Create Warehouse; all fields are optional on update.
Delete Warehouse
Deletes a warehouse. A warehouse still referenced by other records cannot be deleted: sales order lines and fulfillments, fulfillment orders, purchase orders, inbound shipments and receipts, inventory movements and FIFO layers, inventory adjustments and assemblies, stock takes, manufacturing orders, warehouse transfers, RMAs and return receipts, sales credits, vendor credit shipments, vendor returns and their shipments, POS register sessions, Amazon pending inbounds, suppliers using it as their default warehouse, or a connected integration. The 400 response lists each blocking record type under `errors`. If the database still refuses the delete for any other linked record, the endpoint returns 400 and nothing is deleted. Use Check Warehouses Deletable first to see every blocker.
Archive Warehouse
Archives a warehouse, hiding it from active listings. Integration-managed warehouses (e.g. Amazon FBA) and warehouses that still hold available stock cannot be archived.
Unarchive Warehouse
Restores an archived warehouse to active status. Integration-managed warehouses (e.g. Amazon FBA) cannot be modified through this endpoint.
Bulk Archive Warehouses
Archives multiple warehouses. Provide either ids (array of warehouse IDs) or apply_to_all=true with an optional filters object to target all warehouses matching the current listing filters.
Bulk Unarchive Warehouses
Restores multiple archived warehouses. Provide either ids (array of warehouse IDs) or apply_to_all=true with an optional filters object.
Check Warehouses Deletable
Checks whether the given warehouses can be deleted. Provide ids (array of warehouse IDs), or scope='all' to check every warehouse matching the current listing filters.
Check Warehouses Archivable
Checks whether the given warehouses can be archived. Each result includes archivable (boolean) and reason (why archiving is blocked, or null). Integration-managed warehouses and warehouses holding stock are not archivable.
Preview Warehouse Import
Parses an uploaded CSV file and returns a preview before importing: parsed records, detected file headers, the list of importable fields, unmatched columns (difference), missing required columns (required_difference) and columns that cannot be imported (not_importable).
Import Warehouses
Imports warehouses from an uploaded CSV file. Accepts the same payload as Preview Warehouse Import. If required columns are missing, the preview payload is returned instead so the mapping can be corrected. Large files are processed in the background and the response indicates the import will complete shortly.
Export Warehouses
Exports warehouses matching the current filters as a CSV or XLSX file download.
List Fulfillment Dispatch Settings
Returns the fulfillment dispatch configuration for every non-supplier warehouse: the fulfillment channel (order_fulfillment), whether fulfillments are automatically dispatched to the connected shipping provider (auto_dispatch_enabled) and whether partial dispatch is allowed (partial_dispatch_enabled).
Bulk Update Warehouse Dispatch Settings
Updates fulfillment dispatch settings for multiple warehouses in one request.
Get Warehouse Provider Routing Rules
Returns a warehouse's shipping-method routing rules together with the choices available for building them.
Replace Warehouse Provider Routing Rules
Replaces the warehouse's full set of shipping-method routing rules in one atomic operation. Rules not included in the request are removed; send `'rules': []` to clear every rule. Returns the refreshed rule set in the same shape as Get Warehouse Provider Routing Rules, plus a `message`. The change is recorded on the warehouse's activity log. It affects fulfillment orders dispatched after the save; orders already submitted to a provider are not re-routed.
Preview Warehouse Provider Routing Rules
Previews the effect of a candidate routing rule set before saving it. Read-only — nothing is written.
List Product Warehouse Locations
Paginated preferred-location (bin) assignments for products, with the location, warehouse and product relations loaded for display. Filter by product_id + warehouse_id to fetch a single product's ordered bin list.
Create Product Warehouse Location
Assign a preferred storage bin to a product in a warehouse. The location must be an active put-away destination. The first assignment for a product+warehouse automatically becomes the default; new assignments append to the end of the ordered list unless `priority` is given.
Update Product Warehouse Location
Update a preferred-bin assignment. All fields optional (`sometimes`).
Delete Product Warehouse Location
Remove a preferred-bin assignment.
Set Default Preferred Bin
Promote a preferred-bin assignment to the product+warehouse default. The swap is atomic — the previous default for the same product+warehouse is unset.
Reorder Preferred Bins
Reorder a product's preferred bins in a warehouse to match the given id order (top to bottom) and return the fresh ordered list. Priorities are rewritten 0-based and the new top bin becomes the default, so the ordered list matches the resolution order used by put-away and receiving.
List LPNs
Paginated pallets/totes (LPNs) with their bin and content count.
Create LPN
Create an open LPN (pallet/tote), optionally placed in a bin.
Get LPN
A single LPN with its full content manifest.
Add Stock to LPN
Nest stock onto an open LPN. The LPN's bin must physically hold at least the resulting quantity of the product.
Bulk Import Stock to LPN
Nest many products onto an open LPN in one call. Each item is matched by SKU (or barcode) or product id, aggregated per product, and checked against the on-hand quantity in the LPN's bin. Returns a per-row report (status: ok, insufficient, not_found, invalid) plus a summary. Set dry_run=true to validate without persisting; dry_run=false nests every valid product in a single transaction and returns the updated LPN. Items referencing the same product are combined.
Move LPN
Move the whole LPN to another bin — relocating every content line's stock in one transfer.
Close LPN
Close an LPN — it can no longer take stock or move.
List Warehouse Locations
Paginated warehouse locations (bins) with the cached per-location on-hand units (`on_hand`). Deprecated locations are hidden unless `include_deprecated` (top-level or inside `filter[]`) is truthy.
Create Warehouse Location
Create a single warehouse location (bin). Provide either an explicit `code` or at least one of the segment fields (`zone`, `aisle`, `bay`, `shelf`, `bin`) from which a code is derived.
Bulk Generate Warehouse Locations
Generate a range of locations from segment patterns. With `preview: true` the response returns `{codes_sample, total, conflicts}` without persisting; otherwise the non-conflicting codes are inserted and the response returns `{created, skipped_codes}`.
Import Warehouse Locations
CSV import of locations, upserting by the (warehouse, code) natural key. Small files run synchronously and return `{created, updated, skipped}`; large files are queued and return `{queued: true, tracked_job_log_id}` for the job list.
Generate Location Labels
Generate a printable labels PDF (Code-128 barcode + code + type) for the selected locations. Returns a PDF/HTML label sheet as a binary download, NOT JSON.
Get Warehouse Location
Single warehouse location with its warehouse and the cached on-hand summary (`on_hand`).
Update Warehouse Location
Update a warehouse location. All fields are optional (`sometimes`); only provided fields are changed.
Delete Warehouse Location
Hard delete a warehouse location. Only allowed when the location has never been referenced by an inventory movement; otherwise a 422 is returned suggesting deprecation instead.
Deprecate Warehouse Location
Deprecate (soft-retire) a location so it is hidden from pickers and datatables but retains its history. Returns 422 if it is the last active storage location in the warehouse.
Restore Warehouse Location
Restore a previously deprecated location (clears `deprecated_at`).
Lookup Warehouse Locations
Decorated location options for select/autocomplete components. Returns active (non-deprecated) locations of a warehouse in pick-path order (sort_order nulls-last, then code). Returns an empty list when the warehouse does not have locations enabled.
Get Slotting Suggestions
Velocity-aware slotting suggestions for a warehouse: stock whose bin doesn't match its ABC sales-velocity class, or that overfills a bin's capacity. Read-only — proposes moves, never makes them.