API Reference
Knowledge Base

Update a sales return row

patch
https://api.katanamrp.com/v1/sales_return_rows/

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Sales return row id

Body Params

sales return fields to be updated with new values

string

New quantity of the sales return row. Updatable only when current return status is NOT_RETURNED.

integer
≤ 2147483647

Restock location id. Updatable only when current return status is NOT_RETURNED or RETURNED.

integer
≤ 2147483647

Reason id. Updatable only when current return status is NOT_RETURNED.

batch_transactions
array of objects
length ≥ 1

Batch transactions. Updatable only when current return status is NOT_RETURNED or RETURNED. Deprecated — prefer traceability, which takes precedence when both are sent.

batch_transactions
integer
required
≤ 2147483647

Batch id

number
required
≤ 100000000000000000

Quantity

traceability
array of objects

Batch, serial number and bin location breakdown of the returned quantity. Replaces the traceability of the row; send [] to clear it. Preferred over batch_transactions, and takes precedence when both are sent. Updatable only when current return status is NOT_RETURNED or RETURNED. Lowering quantity below the assigned total clears the traceability of the row and changing restock_location_id clears its bin locations, before the traceability sent in the same request is applied.

traceability
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 5 months ago

Did this page help you?