Update Return Item
Updates the price, quantity, or note for a return line item.
Requires scope: returns:write
Authentication
API_KEYstring
API Key authentication via header
Path parameters
id
Return ID.
itemId
Return item ID.
Request
This endpoint expects an object.
price
Updated unit price. Must be zero or greater.
deliveredQuantity
Updated return quantity. Must be greater than zero.
note
Updated note. Pass null to clear.
Response
This endpoint returns an object.
id
Unique identifier for this return item record.
material
Reference to the parent material.
variation
Reference to the material variation, if applicable.
price
Unit price of the material at time of return.
deliveredQuantity
Quantity being returned. Must be greater than zero.
note
Optional note for this line item.
createdAt
ISO 8601 timestamp when the record was created.
updatedAt
ISO 8601 timestamp when the record was last updated.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error