List Vendor Return Allocations
GET/api/vendor-returns/:vendorReturn/allocations
List the inventory allocations linked to this vendor return's lines - its Planned stock reservations plus any successor allocations they were promoted or demoted into. Paginated (10 per page by default). Each allocation carries its product, warehouse, quantity, status, hard-allocated flag, priority, and a link_route back to the source document.
Authentication: Requires Bearer token.
Query parameters:
page(integer, optional) - page number.per_page(integer, optional) - items per page (default 10).
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.