inventoryplanner_list_variants
List variants (forecast and replenishment)
List product variants with Inventory Planner's computed metrics (forecast, replenishment, days to sell out, lost revenue, lead time, review period and ~200 more). Always pass `fields` to pick the metrics you need (default: id,sku,lead_time,review_period,replenishment,oos,under_value; oos = forecasted days to sell out, under_value = forecasted lost revenue, replenishment = recommended order quantity). Use `filters` and `sort` for questions like "which SKUs need reordering". Removed variants are excluded unless include_removed. GET /api/v1/variants.
Parameterspagesortlimitfieldsfiltersinclude_removed
inventoryplanner_get_variant
Get variant
One variant by its Inventory Planner id, with the metrics named in `fields` (default: id,sku,lead_time,review_period,replenishment,oos,under_value). GET /api/v1/variants/{id}.
Parametersfieldsvariant_idrequired
inventoryplanner_list_variant_vendors
List a variant's vendors
The vendors a variant can be ordered from, with cost_price, landing_cost_price, vendor_reference (vendor SKU), vendor_name, vendor_packaging (MOQ) and uom_ordering. GET /api/v1/variants/{id}/vendors.
Parametersvariant_idrequired
inventoryplanner_get_variant_vendor
Get a variant's vendor terms
One vendor's terms for a variant: cost_price, landing_cost_price, vendor_reference, vendor_name, vendor_packaging (MOQ), uom_ordering. vendor_id is the vendor name in lowercase. GET /api/v1/variants/{id}/vendors/{vendor_id}.
Parametersvendor_idrequiredvariant_idrequired
inventoryplanner_list_purchase_orders
List purchase orders (and transfers, assembly orders)
List stock orders: purchase orders, transfers and assembly orders (the `type` field is "po"/empty, "transfer" or "assembly"). Filter with `filters`, e.g. {"status": "OPEN", "vendor": "Acme", "expected_date_lt": "2026-11-01"}. Default fields: id,reference,status,type,vendor,warehouse,source,created_date,expected_date,received_date,currency,total,total_ordered,total_received. GET /api/v1/purchase-orders.
Parameterspagesortlimitfieldsfilters
inventoryplanner_get_purchase_order
Get purchase order
One purchase order, transfer or assembly order by id, with its header fields (reference, status, vendor, warehouse, dates, addresses, totals, notes) and line items. GET /api/v1/purchase-orders/{id}.
Parametersfieldspurchase_order_idrequired
inventoryplanner_list_purchase_order_items
List purchase order line items
The line items of a purchase order: variant id, sku, title, ordered quantity (replenishment), received quantity and received_history, cost price, tax, discount and stock snapshots. GET /api/v1/purchase-orders/{id}/items.
Parameterspagelimitfieldspurchase_order_idrequired
inventoryplanner_get_purchase_order_connections
Get purchase order connection status
Whether and how a purchase order was saved to connected systems (ERP, accounting): per connection the status (success, error, run, queued), save_po flag and the PO's id and reference there. Read-only. GET /api/v1/purchase-orders/{id}/connections.
Parameterspurchase_order_idrequired
inventoryplanner_get_purchase_order_stock_update
Get purchase order stock update (preview)
The stock updates a purchase order has computed: per warehouse (wh) the items with stock_before, delta and error. for_destination false reads the source warehouse of a transfer. Read-only: nothing is pushed. GET /api/v1/purchase-orders/{id}/stock-update.
Parametersfor_destinationpurchase_order_idrequired
inventoryplanner_create_draft_purchase_order
Create a draft purchase order
WRITE: create a purchase order with status "draft" in Inventory Planner (POST /api/v1/purchase-orders). A draft is only a plan inside Inventory Planner: it is NOT sent to the vendor, NOT saved to any connected system and moves no stock or money. Purchase orders only (no transfers or assembly orders). Each line item is a variant id plus the quantity to order (replenishment).
Parametersitemsrequirednotesvendorrequiredcurrencyreferencewarehouserequiredexpected_date
inventoryplanner_update_draft_purchase_order
Edit a draft purchase order
WRITE: change the reference, expected date or notes of a purchase order that is still a draft (PATCH /api/v1/purchase-orders/{id}). The order is read first and refused unless its status is "draft". It never changes the status, sends the order, or touches line items or received quantities.
Parametersnotesreferenceexpected_datepurchase_order_idrequired
