Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This method is work in progress and not yet available.

This method returns information on the current status of the order and the status transitions available to the connected user. Note that internal managers can generally make any status transition whereas a client needs to follow a natural flow of transition (exactly as this is implemented in the Wordbee Translator user interface).

URL

(GET) /api/orders/{orderId}/status/transitions

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 any user (clients, internal users) who has access to the given order online and to the status transitions available there.

  • No labels