@gradientedge/commercetools-utils
    Preparing search index...

    Interface State

    interface State {
        builtIn: boolean;
        createdAt: string;
        createdBy?: CreatedBy;
        description?: LocalizedString;
        id: string;
        initial: boolean;
        key: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        name?: LocalizedString;
        roles?: StateRoleEnum[];
        transitions?: StateReference[];
        type: StateTypeEnum;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    builtIn createdAt createdBy? description? id initial key lastModifiedAt lastModifiedBy? name? roles? transitions? type version

    Properties

    builtIn: boolean

    true for States that are an integral part of the Project. Those States cannot be deleted and their key cannot be changed.

    createdAt: string

    Date and time (UTC) the State was initially created.

    createdBy?: CreatedBy

    IDs and references that created the State.

    description?: LocalizedString

    Description of the State.

    id: string

    Unique identifier of the State.

    initial: boolean

    true for an initial State, the first State in a workflow.

    key: string

    User-defined unique identifier of the State.

    lastModifiedAt: string

    Date and time (UTC) the State was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the State.

    name?: LocalizedString

    Name of the State.

    roles?: StateRoleEnum[]

    Roles the State can fulfill for Reviews and Line Items.

    transitions?: StateReference[]
    • list of States of the same type that the current State can be transitioned to. For example, when the current State is the Initial State of StateType OrderState and this list contains the reference to the Shipped OrderState, the transition Initial -> Shipped is allowed.
      • if empty, no transitions are allowed from the current State, defining the current State as final for this workflow.
      • if not set, the validation is turned off and the current State can be transitioned to any other State of the same type as the current State.
    type: StateTypeEnum

    Indicates to which resource or object types the State is assigned to.

    version: number

    Current version of the State.

    Settings

    Member Visibility

    On This Page

    Properties