Update a sales return

patch

https://api.katanamrp.com/v1/sales_returns/{id}

Updates the specified sales return by setting the values of the parameters passed.
Any parameters not provided will be left unchanged.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Sales return id

Body Params

sales return fields to be updated with new values

status

string

enum

New status of the sales return. RESTOCKED_ALL restocks every row with its traceability. On batch-tracked rows, and on serial-tracked rows depending on the traceability settings of the account, any quantity the batches or serial numbers leave uncovered must have shipped without a batch or serial number, otherwise the restock is rejected (422). Quantity without a bin location is restocked without one.

Allowed:

return_date

string

Date of the return. Must be compatible with ISO 8601 format. Updatable only when current return status is not restockedAll.

order_created_date

string

Creation date of the return. Must be compatible with ISO 8601 format. Updatable only when current return status is not restockedAll.

return_location_id

integer

≤ 2147483647

Updatable only when current return status is not restockedAll.

order_no

string

Updatable only when current return status is not restockedAll.

additional_info

string | null

Additional information about the return. Updatable only when current return status is not restockedAll.

Responses

200Sales order updated

401Make sure you've entered your API token correctly.

404Make sure data is correct

422Check the details property for a specific error message.

429The rate limit has been reached. Please try again later.

500The server encountered an error. If this persists, please contact support