Optional
Readonly
descriptionOptional
Readonly
initialSet to false
if the State is not the first step in a workflow.
Readonly
keyUser-defined unique identifier for the State.
Optional
Readonly
nameName of the State.
Optional
Readonly
rolesIf suitable, assign predifined roles the State can fulfill in case the State's type
is LineItemState
or ReviewState
.
Optional
Readonly
transitionsDefine the list of States of the same type
to which the current State can be transitioned to.
- If, for example, the current State is the _Initial_ State of [StateType](ctp:api:type:StateTypeEnum) `OrderState` and you want to allow the transition _Initial_ -> _Shipped_, then add the [StateResourceIdentifier](ctp:api:type:StateResourceIdentifier) to the _Shipped_ `OrderState` to this list.
- Set to empty list for not allowing any transition from the current State and defining it as final State for a workflow.
- Do not set this field at all to turn off validation and allowing transitions to any other State of the same `type` as the current State.
Readonly
typeSpecify to which resource or object type the State is assigned to.
Description of the State.