List Returnable Lines For Purchase Order
GET/api/vendor-returns/returnable-lines/:purchaseOrder
For each line of a purchase order, report how much was received, how much has already been returned (across all non-void vendor returns, plus historical restock credits), and how much remains returnable. Use this before creating a vendor return to know which lines and quantities are still available to return.
Authentication: Requires Bearer token.
Response fields per line:
- purchase_order_line_id (integer)
- product_id (integer, nullable)
- sku (string, nullable)
- name (string): product name, or the line description when there is no product
- received_quantity (number)
- already_returned_quantity (number)
- returnable_quantity (number): received minus already returned, never below 0
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.