Optional ReadonlydescriptionOptional ReadonlyinitialSet to false if the State is not the first step in a workflow.
ReadonlykeyUser-defined unique identifier for the State.
Optional ReadonlynameName of the State.
Optional ReadonlyrolesIf suitable, assign predefined roles the State can fulfill in case the State's type is LineItemState or ReviewState.
Optional ReadonlytransitionsDefine 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.
ReadonlytypeSpecify to which resource or object type the State is assigned to.
Description of the State.