To update the status of an order.
Note: This method is accessible to internal client portal (order) managers only. It allows to change the status freely without any constraints regarding recommended status transitions.
URL
(PUT) /api/orders/{orderId}
PARAMETERS
URL parameters are:
orderId | The numeric order ID. See orders/list to find orders. | integer, Mandatory |
The body must be a JSON object with these properties:
status | The new order status. See Order status for all options. | 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 |
RESULTS
None.
ACCESS RIGHTS
This method is available to internal users only and who have global order management access rights.