Add Line to Return Receipt
POST/api/return-receipts/:returnReceipt/lines
Add a new line to an existing return receipt. Creates an inventory movement for the specified action.
returns:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Fields:
- product_id (required): Product being returned
- original_product_id (optional): Original product if different (e.g., substituted)
- rma_line_id (optional): Link to specific RMA line
- quantity (required): Quantity received (min: 1)
- action (required): One of: return_to_stock, dispose, refurbish
- return_reason_id (optional): ID of return reason
- notes (optional): Notes (max 500 chars)
Requires permission: returns.receive
Request
Responses
- 201
- 401
- 403
- 404
- 422
- 429
Created
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.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
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.