Skip to main content
PUT
Update an order
Applies the whitelisted fields (status, notes, shippingCost, discount, additionalInfo) and returns the re-fetched, fully populated order. Status changes notify the customer. The store is bound to your app token server-side — never send a shop id. additionalInfo is a list of custom labelled { label, value } entries attached to the order (e.g. a gift message or delivery instructions). It is replaced wholesale — send the full list you want the order to end up with. Entries without a label are dropped and the list is capped at 50 entries.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Path Parameters

id
string
required

The order's id (Mongo ObjectId).

Body

application/json
status
enum<string>

New order status.

Available options:
pending,
processing,
paid,
cancelled,
refunded,
completed
notes
string

Internal order notes.

shippingCost
number

Shipping cost for the order.

discount
number

Order-level discount amount.

additionalInfo
object[]

Replaces the order's additional info with this list of labelled key/value entries (max 50).

Maximum array length: 50

Response

The updated, fully populated order.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

A fully populated order as returned by the get-by-id and update endpoints.