Page Comparison

current

Contains the current order’s status.

object

current.status

The current (numeric) status. See Order status

integer

current.statust

Status print title.

string

transitions

Array with all status transitions available given the context of the order. These are typically the transitions that a regular user can choose from. Only internal managers can side step this list.

Example:

"transitions": [
{
	"title": "Close order",
	"status": 5,
	"statust": "Closed",
	"isDefault": true,
	"instructions": "Click OK to confirm that this order can be closed."
},
...
]

See table below for details.

object[]

overrides

An array of status transitions that a manager-level user has access to. Whereas transitions are the recommended statuses, overrides are used to fix any issues or handle exceptions.

The overrides contain the numeric status code and the print title.

The list is empty unless the user is an internal manager.

Example:

"overrides": [
{
	"status": 3,
	"statust": "Work done"
},
...]

object[]

isClient

Boolean. Indicates if the connected user is the client for the order or not.

bool

canChangeStatus

Boolean. Indicates if the user can make any status transition. If not then the transitions array is empty.

bool

canOverrideStatus

Boolean. Indicates if the user can make any status overrides. If not then the overrides array is empty.