Get Product Inbound Shipment Lines
GET/api/v2/products/:product/inbound-shipment-lines
Get every inbound shipment line for a product with where the shipment stands: expected, received and what is still to come.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Each line carries a buckets array naming the states it is in:
in_transit— shipment has left the supplier (in transit or partially received), units not yet receivedplanned— shipment is planned but has not left the supplier yetreceived— anything received, whatever the shipment's status
A partially received line is in both in_transit and received. Closed shipments never count as in transit; draft shipments, cancelled shipments that received nothing, and lines in no bucket are omitted.
unreceived_quantity is expected less received, floored at zero — still on the way for a shipped line, still to ship for a planned one. supplier_id and supplier_name come from the shipment when it names a supplier, otherwise from the line's purchase order. created_from_receipt marks a shipment that was generated automatically to wrap a receipt recorded directly against a purchase order. carrier and tracking_number are the shipment's primary tracking; additional_tracking lists any further carrier/tracking pairs (for example one per container).
The top-level uses_inbound_shipments flag is true when the account has ever created an inbound shipment itself (automatically generated ones do not count), so a client can tell whether inbound shipments are in use at all.
Each row is one shipment LINE, identified by line_id — a shipment can carry more than one line for the same product. Results are ordered newest shipment first.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 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.
Unprocessable Content
Response Headers
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.