Get Vendor Return
GET/api/vendor-returns/:vendorReturn
Get a single vendor return with its lines, outbound shipments, and any vendor credits created from it.
Authentication: Requires Bearer token.
Response notes:
- purchase_order is derived from the return's lines (a return references purchase orders through its lines)
- lines[].clearing_quantity / lines[].ap_quantity are set at ship time: the un-invoiced portion posts to the vendor-returns clearing account, the invoiced portion posts to accounts payable
- lines[].credited_quantity is the quantity already covered by vendor credit lines referencing the return line
- is_fully_credited is true once every line is fully covered by vendor credits
- total_cost is the sum of line quantity x unit cost
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Content-Type
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
Response Headers
Content-Type
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.