Get inventory supply chain map

GET /api/v1/inventory/supply-chain

Return a single payload of nodes (locations with on-hand + alerts) and edges (open POs + in-transit transfers) for the Supply Chain Map.

Operation ID: get_supply_chain_map_api_v1_inventory_supply_chain_get · View as markdown · OpenAPI slice

Responses

Schema: SupplyChainResponse

nodes array · SupplyChainNode SupplyChainNode

12 fields

id string required: Location ID.
name string required: Display name of the location.
code string: Short code (e.g. 'WH1').
location_type string required: LocationTypeEnum value.
is_default boolean: Whether this is the business default location.
city string: City for layout grouping.
state string: State/region for layout grouping.
on_hand_units number: Total units on hand at this location across all variants.
on_hand_value_cents integer: Total value of on-hand inventory at this location, in cents.
open_po_count integer: POs with this location as ship_from or ship_to and a non-terminal status.
low_stock_count integer: Variants at this location whose available <= reorder_point.
vendor_id string: Vendor whose default_location_id points here, if any.

edges array · SupplyChainEdge SupplyChainEdge

8 fields

id string required: Underlying PO or Transfer ID.
kind string required: 'purchase_order' or 'transfer'.
from_location_id string: Source location ID.
to_location_id string: Destination location ID.
label string: Human-readable label (e.g. 'PO-123' or 'TRF-456').
status string required: Current status of the PO or transfer.
total_cents integer: PO total (for PO edges) in cents. None for transfers.
expected_arrival_date string · date-time: When goods are expected to arrive.

generated_at string · date-time required

Server time the payload was computed.

Schema: HTTPValidationError

detail array · ValidationError ValidationError

5 fields