Get PO Shipment Line Options
GET/api/purchase-orders/:purchase_order/shipment-line-options
Lines for the Create Shipment / Add to Existing Shipment pickers on the PO Shipments tab.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Returns every unreceived line on the PO with server-computed assigned_quantity (units already claimed by live inbound shipments — InTransit, PartiallyReceived, Received) and available_quantity (what the user can still add). Draft, Cancelled, and Closed shipments do NOT count toward assigned_quantity.
Fully-received lines (effective_received >= quantity) are excluded. AWD / FBA receipts are honoured via getEffectiveReceivedQuantity so received quantity is correct even when the received_quantity column is not directly updated.
There is intentionally no pagination cap — a single PO can have hundreds of lines and silent truncation hid line items from users (Freshdesk #1892).
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.