Stock & transfers

Returns the paging caps, sort columns, item types, the user reason enum accepted by adjustments, the adjustment batch cap, and the movement retention window enforced by the services.

Returns one row per (item, location) across simple products, variants, and inventory groups: on-hand quantity, reserved, available, backorder/preorder demand, low-stock threshold and state. Filter by location, item type, SKU search, or low-stock only. Query validation is strict: invalid sort or filter values return coded 400s, never silent defaults.

Returns the append-only ledger every stock change writes — admin edits, imports, scanner sessions, transfers, order fulfillment, and your own adjustments — newest first. reference_type and reference_id (e.g. the order behind a movement) are included only when the token also holds read_orders; without it the movement row is returned with those fields omitted. Rows are retained for the window reported by the limits endpoint.

Returns items whose available stock is at or below the configured threshold, with the deficit (threshold minus available). Covers per-location thresholds and inventory-group overall thresholds; filter by scope, type, or location.

Applies up to the batch cap of adjustments in one request. Each row addresses an item by SKU — simple product, variant, or inventory group resolve identically — at one location, and either adjusts by a signed delta (adjust) or writes an absolute quantity (set). App tokens may target merchant-managed locations and locations owned by their own active installation; they cannot write another app's location. Rows are applied independently: the response reports per-row success or a coded error, and one bad row never rolls back the others. Every applied row writes the movement ledger with your app as the actor, re-evaluates low-stock, and emits inventory_levels/update. Deltas are safe under concurrency; prefer them over set unless you are reconciling a physical count.

Returns paginated transfers with status, locations, item counts, and total quantity. Filter by status or date range; search matches the reference number.

Returns the transfer, its status history timestamps, and every line item with quantities.

Creates a pending transfer. Items address stock by item type and id; quantities are validated against available stock at the source location. Creating a transfer reserves nothing — stock moves when the transfer completes.

Moves the transfer through its lifecycle: pending → in_transit (ship), in_transit → completed (receive) or cancelled. Completing is the stock-mutating step: it decrements the source location and increments the destination atomically, writing transfer_out/transfer_in movement rows and inventory_levels/update webhooks for both locations.

Deletes a transfer that has not shipped. Transfers that are in transit, completed, or cancelled are immutable history and cannot be deleted.

Returns customer "notify me when available" requests with product, status, and lifecycle timestamps — restock demand data for planning. Contact details (email or phone) are PII: they are returned only when the token also holds read_customers, and arrive redacted otherwise. The response's can_view_contact flag reports which mode you are in.