Skip to main content

Get Product Purchase Order Lines

GET 

/api/v2/products/:product/purchase-order-lines

Get purchase order lines for a product, filtered by status.

Required scope: products:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Excludes draft purchase orders. With status=inbound, on an opening-balance purchase order unreceived_quantity is only the quantity on open inbound shipments (the rest was received before the inventory start date), and a line with nothing on an open shipment is left out.

Each row carries an effective ETA (eta) describing when the stock is expected to arrive. When the line is packed onto an inbound shipment that is still arriving (planned, in transit, or partially received), the earliest such shipment's expected arrival date wins and eta_source is inbound_shipment, with eta_shipment_id and eta_shipment_number identifying it. Otherwise the purchase order's own estimated delivery date is used and eta_source is purchase_order. When neither is set, eta and eta_source are null.

Rows with status=inbound are returned ordered by eta ascending, with undated rows last, so the next stock to land is first.

Request​

Responses​

OK

Response Headers
    Content-Type