Update an order

PATCH 
/v1/orders/:id

Edits basic fields of an order and returns the updated order. Only orders created through the API can be edited here (source: API); an order placed on the storefront, the POS or a food app must be edited where it was placed.

Send at least one field; comment is appended to the order's existing comment upstream rather than replacing it. currency is always taken from your credential. Status, items, payments and discounts each have their own endpoint and cannot be changed here.

Required scope: orders:write

Request

Responses

200

The updated order.

401

Unauthenticated — the request is missing a credential, or the Bearer token / API key is invalid, expired, or revoked.

403

Insufficient scope — the credential is authenticated but lacks a scope the endpoint requires.

404

Not found — no resource matches the id in the path (or it belongs to a different company).

422

Validation failed — the request body failed schema validation. errors[] lists every offending field.