Docs

Set Order Status

PATCH /Orders/{orderId}/status

PATCH/Orders/{orderId}/status

Declares the order's status. External orders accept Draft, Sent, Confirmed, Abandoned or Canceled; internal orders accept Draft, Ordered or Canceled; a move the lifecycle does not allow is refused. Declaring an order out (Sent or Confirmed, or Ordered when internal) also marks its unsent revision as sent. The status shown on reads is derived from quotes, invoices and payments and can be higher than the declared one. To undo Abandoned or Canceled, use Orders_ReopenOrder.

Path Parameters

FieldTypeRequiredDescription
orderIduuidRequired

Request Body

FieldTypeRequiredDescription
statusstringOptional