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

    Interface ApprovalFlow

    interface ApprovalFlow {
        approvals: ApprovalFlowApproval[];
        businessUnit: BusinessUnitKeyReference;
        createdAt: string;
        createdBy?: CreatedBy;
        currentTierPendingApprovers: RuleApprover[];
        custom?: CustomFields;
        eligibleApprovers: RuleApprover[];
        id: string;
        lastModifiedAt: string;
        lastModifiedBy?: LastModifiedBy;
        order: OrderReference;
        pendingApprovers: RuleApprover[];
        rejection?: ApprovalFlowRejection;
        rules: ApprovalRule[];
        status: ApprovalFlowStatus;
        version: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    approvals businessUnit createdAt createdBy? currentTierPendingApprovers custom? eligibleApprovers id lastModifiedAt lastModifiedBy? order pendingApprovers rejection? rules status version

    Properties

    approvals: ApprovalFlowApproval[]

    Existing approvals in the Approval Flow.

    businessUnit: BusinessUnitKeyReference

    Business Unit the Approval Flow belongs to.

    createdAt: string

    Date and time (UTC) the Approval Flow was initially created.

    createdBy?: CreatedBy

    IDs and references that created the ApprovalFlow.

    currentTierPendingApprovers: RuleApprover[]

    Associate Roles required for approval based on the approver hierarchy tiers defined in rules only for the currently active tier(s).

    custom?: CustomFields

    Custom Fields on the Approval Flow.

    eligibleApprovers: RuleApprover[]

    Associate Roles that can approve according to the approver hierarchy tiers defined in rules. Associates are allowed to reject even after they have given approval, as long as the current approver hierarchy tier still contains their role.

    id: string

    Unique identifier of the Approval Flow.

    lastModifiedAt: string

    Date and time (UTC) the Approval Flow was last updated.

    lastModifiedBy?: LastModifiedBy

    IDs and references that last modified the ApprovalFlow.

    order: OrderReference

    Order that needs to be approved.

    pendingApprovers: RuleApprover[]

    Associate Roles required for approval based on the approver hierarchy tiers defined in rules across all remaining tiers.

    rejection?: ApprovalFlowRejection

    Present when the status of the Approval Flow is Rejected.

    rules: ApprovalRule[]

    Approval Rules that matched the Order.

    status: ApprovalFlowStatus

    Indicates whether the Approval Flow is under review, approved, or rejected.

    version: number

    Current version of the Approval Flow.

    Settings

    Member Visibility

    On This Page

    Properties