Update a sales order

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
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Sales order id

Body Params

sales order fields to be updated with new values

string
length ≥ 1

Updatable only when sales order status is NOT_SHIPPED or PENDING.

integer
≤ 2147483647

Updatable only when sales order status is NOT_SHIPPED or PENDING.

string
string

Updatable in all sales order statuses except DELIVERED.

string

Updatable only when sales order status is NOT_SHIPPED or PENDING.

integer
≤ 2147483647

Updatable only when sales order status is NOT_SHIPPED or PENDING.

string
enum

When the status is omitted, it stays unchanged.
Use PENDING when you want to create sales order quotes.
PACKED and DELIVERED are applied asynchronously: the response still shows the previous status, and the
fulfillment is created shortly after.

Allowed:
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.

number

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

string

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

string | null
string | null
string | null

Pre-fills the tracking of the sales order’s next shipment. When a fulfillment is created without its own tracking, this value moves onto that fulfillment and is cleared from the sales order. A sales order can ship in several fulfillments, each with its own tracking, so after shipping read and set tracking on /sales_order_fulfillments. If the sales order already has fulfillments, the value is written to all of them, so on a partially delivered sales order it overwrites the tracking of the earlier shipments. A fully delivered sales order with more than one fulfillment returns 422. To set the tracking of one shipment, use PATCH /sales_order_fulfillments/{id}.

string | null

Pre-fills the tracking of the sales order’s next shipment. When a fulfillment is created without its own tracking, this value moves onto that fulfillment and is cleared from the sales order. A sales order can ship in several fulfillments, each with its own tracking, so after shipping read and set tracking on /sales_order_fulfillments. If the sales order already has fulfillments, the value is written to all of them, so on a partially delivered sales order it overwrites the tracking of the earlier shipments. A fully delivered sales order with more than one fulfillment returns 422. To set the tracking of one shipment, use PATCH /sales_order_fulfillments/{id}.

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
LoadingLoading…
Response
Choose an example:
application/json