API Reference
Knowledge Base

Update a sales order row

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

Updates the specified sales order 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 order row id

Body Params

sales order row fields to be updated with new values

number
≤ 100000000000000000

Updatable only when sales order row status is NOT_SHIPPED or PENDING.

integer

Updatable only when sales order row status is NOT_SHIPPED or PENDING.

integer

Updatable only when sales order row status is NOT_SHIPPED or PENDING.

integer

Updatable only when sales order row status is NOT_SHIPPED or PENDING and sales order row is not linked to a manufacturing order (linked_manufacturing_order_id is null).

number
≤ 1000000000000000000

Updatable only when sales order row status is NOT_SHIPPED or PENDING.

number
≤ 1000000000000000000

Updatable only when sales order row status is NOT_SHIPPED or PENDING.

batch_transactions
array of objects
deprecated

Batch-level breakdown of the row quantity. Deprecated — will be phased out; prefer traceability. When traceability is sent it wins over batch_transactions + serial_number_transactions.

batch_transactions
serial_number_transactions
array of objects
deprecated

Serial-number breakdown of the row quantity. Deprecated — will be phased out; prefer traceability. When traceability is sent it wins over batch_transactions + serial_number_transactions.

serial_number_transactions
traceability
array of objects

Unified allocation breakdown of the row quantity (batch / serial / bin). Preferred over batch_transactions + serial_number_transactions; when traceability is sent it wins. Sending an empty array clears the row allocations, whereas omitting it leaves them unchanged.

traceability
attributes
array of objects

When updating attributes, all keys and values must be provided.
Existing ones are replaced with new attributes.

attributes
custom_fields
object | null

Custom field values keyed by custom field definition ID (UUID). Each value matches the definition’s field_type — string for shortText/url, number for number, boolean for boolean, YYYY-MM-DD string for date, or the integer choice id for singleSelect. Merged with existing values — omit a key to leave it unchanged. Set the whole field to null to clear every custom field value on this row.

Responses

Updated about 2 months ago

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

Updated about 2 months ago

Did this page help you?