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

idUUIDRequired
Return ID.
itemIdUUIDRequired
Return item ID.

Request

This endpoint expects an object.
pricedoubleOptional
Updated unit price. Must be zero or greater.
deliveredQuantitydoubleOptional
Updated return quantity. Must be greater than zero.
notestringOptional

Updated note. Pass null to clear.

Response

This endpoint returns an object.
idUUID
Unique identifier for this return item record.
materialobject
Reference to the parent material.
variationobject
Reference to the material variation, if applicable.
pricedouble
Unit price of the material at time of return.
deliveredQuantitydouble
Quantity being returned. Must be greater than zero.
notestring
Optional note for this line item.
createdAtdatetime
ISO 8601 timestamp when the record was created.
updatedAtdatetime
ISO 8601 timestamp when the record was last updated.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error