Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Any user who can change the status of the order online is also authorized to use this API methods. Some status transitions are authorized for internal manager-level users only. Typical client users can only make status transitions that “make sense” in the current context of the order (such as accepting or rejecting results). To retrieve available transitions use: orders/{orderId}/status/transitions

URL

Code Block
(PUT) /api/orders/{orderId}/status

PARAMETERS

URL parameters are:

...

status

The new order status. See Order status for all optionsthe numeric values. Also check out orders/{orderId}/status/transitions for getting a list of possible status transitions.

integer. Mandatory

message

Optional text message to save with the status change in the order history. This text will also be included in the email notification.

string?, Optional

notify

Optional. Default is true.

If set to false (not recommended) then the system will not notify the client and other stakeholders of the status translation.

If dropped or set to true then a regular email notification will be sent out.

bool?, Optional

...