Update a sales order

patch

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

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

id

integer

required

Sales order id

Body Params

sales order fields to be updated with new values

order_no

string

length ≥ 1

Updatable only when sales order status is NOT_SHIPPED or PENDING.

customer_id

integer

≤ 2147483647

Updatable only when sales order status is NOT_SHIPPED or PENDING.

order_created_date

string

delivery_date

string

Updatable only when sales order status is NOT_SHIPPED or PENDING.

picked_date

string

Updatable only when sales order status is NOT_SHIPPED or PENDING.

location_id

integer

≤ 2147483647

Updatable only when sales order status is NOT_SHIPPED or PENDING.

status

string

enum

When the status is omitted, NOT_SHIPPED is used as default.
Use PENDING when you want to create sales order quotes.

Allowed:

currency

string

E.g. USD, EUR. All currently active currency codes in ISO 4217 format.
Updatable only when sales order status is NOT_SHIPPED or PENDING.

conversion_rate

number

Updatable only when sales order status is PACKED or DELIVERED, otherwise it will fail with 422.

conversion_date

string

Updatable only when sales order status is PACKED or DELIVERED, otherwise it will fail with 422.

additional_info

string | null

customer_ref

string | null

tracking_number

string | null

tracking_number_url

string | null

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 sales order.

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json