Interface UnleashedSoftwareNodeParameters

Source
interface UnleashedSoftwareNodeParameters {
    filters?:
        | {
            customerCode?: string;
            customerId?: string;
            endDate?: string;
            modifiedSince?: string;
            orderNumber?: string;
            orderStatus?: (
                | "Completed"
                | "Deleted"
                | "Backordered"
                | "Parked"
                | "Placed"
            )[];
            startDate?: string;
        }
        | {
            asAtDate?: string;
            IsAssembled?: boolean;
            modifiedSince?: string;
            orderBy?: string;
            productId?: string;
            warehouseCode?: string;
            warehouseName?: string;
        };
    limit?: number;
    operation?: "get"
    | "getAll";
    productId?: string;
    resource?: "salesOrder" | "stockOnHand";
    returnAll?: boolean;
}

Properties§

Source§

readonly filters?:
    | {
        customerCode?: string;
        customerId?: string;
        endDate?: string;
        modifiedSince?: string;
        orderNumber?: string;
        orderStatus?: (
            | "Completed"
            | "Deleted"
            | "Backordered"
            | "Parked"
            | "Placed"
        )[];
        startDate?: string;
    }
    | {
        asAtDate?: string;
        IsAssembled?: boolean;
        modifiedSince?: string;
        orderBy?: string;
        productId?: string;
        warehouseCode?: string;
        warehouseName?: string;
    }

Default: {}

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":1000}

Source§

readonly operation?: "get" | "getAll"

Default: "getAll"

Source§

readonly productId?: string

Source§

readonly resource?: "salesOrder" | "stockOnHand"

Default: "salesOrder"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit