Product Inventory Service (2026-10-17.2958151882)

Returns the in-warehouse stock of one of your products, aggregated into rows keyed on (arrival_batch_id, best_before_date, batch_number) — extended with the reserving order id when include_order_breakdown=true. Each row carries available_quantity / reserved_quantity / total_quantity, the earliest on-shelf timestamp, and references to the inbound shipment and (optionally) the reserving order. Articles that have already shipped are excluded.

Returns the units of one of your inbound shipments, aggregated into rows keyed on (product, in_warehouse_status, batch_number, best_before_date). in_warehouse_status tells you where each unit is in its lifecycle (inbound = expected, arrived = received but not yet shelved, on_shelf, picked, …). Each row carries the total_quantity and the product (id, sku, name). Filter with in_warehouse_status; paginated with offset/limit (up to 500 rows per page). Inbound shipments that do not belong to you return an empty list.

Returns the chronological inventory movement history for one of your products. Each entry records a timestamp, movement type (e.g. inbound_shipment.to_shelf, order_pickup.picked), article count, and references to the related inbound shipment or order when applicable. Supports time-range and type filters; paginated with offset/limit (up to 500 rows per page). Products that do not belong to your merchant return an empty list.

Returns your products that are in on_shelf state but have not shipped in the last minDaysIdle days (default 30). Aggregated per product: qty_on_shelf sums the on-shelf article count across every shelf position, last_outbound_at is the MAX shipped-timestamp across those positions, and days_idle is derived from last_outbound_at (or the most recent shelving when that is null). Minimum-age guard excludes products whose most recent shelving is more recent than the cutoff, so fresh inbound stock doesn't show as idle. Sorted oldest-idle first, paginated with offset/limit (up to 500 rows per page).

Returns a point-in-time aggregate of stock quantity × purchase value across your in-warehouse ProductArticles (on_shelf or picked, not yet shipped). Optionally group by batch_number, best_before_date, or purchase_value_currency; defaults to a single grand-total row when group_by is omitted. Returns both per-group rows and grand totals for the requested KPIs (stock_value, article_count; both computed by default).

Returns a historical, date-ranged aggregate of stock quantity × purchase value from periodic warehouse snapshots for your products. Optionally group by stat_date and/or product_id (combine both for a per-product timeline); defaults to a single grand-total row when group_by is omitted. Set the date range with stat_date_min (required) and stat_date_max (optional, defaults to today), both YYYY-MM-DD and inclusive; the range may span at most 92 days. Returns both per-group rows and grand totals for the requested KPIs (stock_value, article_count; both computed by default).

For an order that is waiting for stock, lists what it is still missing and which of your other orders hold that stock on the shelf and could give it up, so this order can ship first. Each product shows how many units are missing (shortfall) and any best-before date or batch requirement of the order line; only stock matching that requirement is counted. Each proposed order shows how many units it could give per product and whether it alone covers everything that is missing. Orders that only cover part of it are listed too. Only orders in status confirmed or waiting_products that are not yet being picked are proposed, and stock already being picked for an order is never counted. Nothing is changed. Error codes: RECEIVING_ORDER_STATUS_NOT_ALLOWED — the order is not confirmed or waiting_products; RECEIVING_ORDER_LOCKED_FOR_PICKING — the order is already being picked; RECEIVING_ORDER_NOT_IN_QUEUE — the order is not yet ready for fulfilment.

Moves stock that is reserved on the shelf for the given orders (donor_order_ids, at most 20, all yours) to this order, so it can ship first. Only what this order is missing is moved; in exchange this order gives up the reservations that were still waiting for stock, so every order keeps its reserved amount and the other orders wait for the next stock instead. Best-before date and batch requirements of this order's lines are respected. Everything happens at once or not at all, and every rule is checked again at that moment, so the result may differ from an earlier proposal. Use dry_run: true to preview the result without changing anything. An order or product that could not give stock is reported in the response with a reason code instead of failing the request: DONOR_ORDER_NOT_FOUND (not one of your orders), DONOR_ORDER_STATUS_NOT_ALLOWED (not confirmed or waiting_products), DONOR_ORDER_LOCKED_FOR_PICKING (already being picked), DONOR_ORDER_NOT_IN_QUEUE (not yet ready for fulfilment), DONOR_ORDER_IS_RECEIVING_ORDER, NO_ELIGIBLE_UNITS (no matching stock on the shelf), SHORTFALL_ALREADY_COVERED, PRODUCT_LIMIT_REACHED (your product_limits cap), PRODUCT_HAS_MULTIPLE_RESTRICTION_SLOTS (the product is on several order lines with different best-before or batch requirements and is left alone). The change is recorded in the logbook of every order involved.

Moves the units of one of your products (source_sku) that are on the shelf and available into another SKU (target.sku), keeping each unit on its shelf and with its best-before date. Use it, for example, to separate a best-before batch into its own product. Units that are reserved for orders, being picked, not yet shelved, blocked, or removed are never moved. If you have no product with the target SKU it is created as a copy of the source product (name, translations and other details; you can override the name); an existing target product is used as it is. filters narrow down what is moved: best_before (exact date), location (shelf code) and max_quantity, combined with AND. If nothing matches, the request succeeds with moved_quantity 0 and nothing is created. The source units are blocked with an incident and the same number of units appear in the target product, booked through a system-made inbound shipment without invoicing; no inbound_shipment.processed webhook is sent for it, but inventory change webhooks are sent for both products. The Idempotency-Key header is required: repeat the request with the same key to safely retry, and the first result is returned. A single split moves at most 5000 units. Only one split of the same source product runs at a time (409 SPLIT_IN_PROGRESS; retry shortly). If the stock records of the source product are inconsistent the request is refused with 409 PHANTOM_STOCK_SUSPECTED and nothing is changed; contact Logitrail support.