nodes/generated

Interface Magento2NodeParameters

Source


interface Magento2NodeParameters {
    additionalFields?:
        | {
            addresses?: {
                address: {
                    city: string;
                    company?: string;
                    country_id: string;
                    default_billing?: boolean;
                    default_shipping?: boolean;
                    fax?: string;
                    firstname: string;
                    lastname: string;
                    middlename?: string;
                    postcode: string;
                    prefix?: string;
                    region?: string;
                    street: string;
                    suffix?: string;
                    telephone: string;
                }[];
            };
            amazon_id?: string;
            confirmation?: string;
            customAttributes?: {
                customAttribute: {
                    attribute_code?: string;
                    value?: string;
                }[];
            };
            default_billing?: string;
            default_shipping?: string;
            dob?: string;
            gender?: 1
            | 3
            | 2;
            group_id?: string;
            is_subscribed?: boolean;
            middlename?: string;
            password?: string;
            prefix?: string;
            store_id?: string;
            suffix?: string;
            vertex_customer_code?: string;
            vertex_customer_country?: string;
            website_id?: string;
        }
        | {
            attribute_set_id?: string;
            name?: string;
            price?: number;
            status?: 1
            | 2;
            type_id?: string;
            visibility?: 1 | 3 | 2 | 4;
            weight?: number;
        };
    attributeSetId?: string;
    customerId?: string;
    email?: string;
    filterJson?: string;
    filters?: {
        conditions: {
            condition_type?: | "in"
            | "gt"
            | "lte"
            | "lt"
            | "eq"
            | "gteq"
            | "like"
            | "moreq"
            | "neq"
            | "nin"
            | "notnull"
            | "null";
            field?: string;
            value?: string;
        }[];
    };
    filterType?: "none"
    | "manual"
    | "json";
    firstname?: string;
    firstName?: string;
    lastname?: string;
    lastName?: string;
    limit?: number;
    matchType?: "anyFilter" | "allFilters";
    name?: string;
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "update"
        | "delete"
        | "cancel"
        | "ship";
    options?: {
        sort?: {
            sort: {
                direction?: "ASC"
                | "DESC";
                field?: string;
            }[];
        };
    };
    orderId?: string;
    price?: number;
    resource?: "customer"
    | "invoice"
    | "product"
    | "order";
    returnAll?: boolean;
    sku?: string;
    updateFields?:
        | {
            addresses?: {
                address: {
                    city: string;
                    company?: string;
                    country_id: string;
                    default_billing?: boolean;
                    default_shipping?: boolean;
                    fax?: string;
                    firstname: string;
                    lastname: string;
                    middlename?: string;
                    postcode: string;
                    prefix?: string;
                    region?: string;
                    street: string;
                    suffix?: string;
                    telephone: string;
                }[];
            };
            amazon_id?: string;
            confirmation?: string;
            customAttributes?: {
                customAttribute: {
                    attribute_code?: string;
                    value?: string;
                }[];
            };
            default_billing?: string;
            default_shipping?: string;
            dob?: string;
            gender?: 1
            | 3
            | 2;
            group_id?: string;
            is_subscribed?: boolean;
            middlename?: string;
            password?: string;
            prefix?: string;
            store_id?: string;
            suffix?: string;
            vertex_customer_code?: string;
            vertex_customer_country?: string;
            website_id?: string;
        }
        | {
            attribute_set_id?: string;
            name?: string;
            price?: number;
            status?: 1
            | 2;
            type_id?: string;
            visibility?: 1 | 3 | 2 | 4;
            weight?: number;
        };
    website_id?: string;
}

Properties§

§readonly additionalFields?:
    | {
        addresses?: {
            address: {
                city: string;
                company?: string;
                country_id: string;
                default_billing?: boolean;
                default_shipping?: boolean;
                fax?: string;
                firstname: string;
                lastname: string;
                middlename?: string;
                postcode: string;
                prefix?: string;
                region?: string;
                street: string;
                suffix?: string;
                telephone: string;
            }[];
        };
        amazon_id?: string;
        confirmation?: string;
        customAttributes?: {
            customAttribute: {
                attribute_code?: string;
                value?: string;
            }[];
        };
        default_billing?: string;
        default_shipping?: string;
        dob?: string;
        gender?: 1
        | 3
        | 2;
        group_id?: string;
        is_subscribed?: boolean;
        middlename?: string;
        password?: string;
        prefix?: string;
        store_id?: string;
        suffix?: string;
        vertex_customer_code?: string;
        vertex_customer_country?: string;
        website_id?: string;
    }
    | {
        attribute_set_id?: string;
        name?: string;
        price?: number;
        status?: 1
        | 2;
        type_id?: string;
        visibility?: 1 | 3 | 2 | 4;
        weight?: number;
    }

Default: {}

§readonly attributeSetId?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getAttributeSets"}

§readonly customerId?: string

ID of the customer to update

§readonly email?: string

Email address of the user to create

§readonly filterJson?: string
§readonly filters?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly filterType?: "none" | "manual" | "json"

Default: "none"

§readonly firstname?: string

First name of the user to create

§readonly firstName?: string
§readonly lastname?: string

Last name of the user to create

§readonly lastName?: string
§readonly limit?: number

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

§readonly matchType?: "anyFilter" | "allFilters"

Default: "anyFilter"

§readonly name?: string
§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "cancel"
    | "ship"

Default: "create"

§readonly options?: { ... }

Default: {}

§readonly orderId?: string
§readonly price?: number
§readonly resource?: "customer" | "invoice" | "product" | "order"

Default: "customer"

§readonly returnAll?: boolean

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

§readonly sku?: string

Stock-keeping unit of the product

§readonly updateFields?:
    | {
        addresses?: {
            address: {
                city: string;
                company?: string;
                country_id: string;
                default_billing?: boolean;
                default_shipping?: boolean;
                fax?: string;
                firstname: string;
                lastname: string;
                middlename?: string;
                postcode: string;
                prefix?: string;
                region?: string;
                street: string;
                suffix?: string;
                telephone: string;
            }[];
        };
        amazon_id?: string;
        confirmation?: string;
        customAttributes?: {
            customAttribute: {
                attribute_code?: string;
                value?: string;
            }[];
        };
        default_billing?: string;
        default_shipping?: string;
        dob?: string;
        gender?: 1
        | 3
        | 2;
        group_id?: string;
        is_subscribed?: boolean;
        middlename?: string;
        password?: string;
        prefix?: string;
        store_id?: string;
        suffix?: string;
        vertex_customer_code?: string;
        vertex_customer_country?: string;
        website_id?: string;
    }
    | {
        attribute_set_id?: string;
        name?: string;
        price?: number;
        status?: 1
        | 2;
        type_id?: string;
        visibility?: 1 | 3 | 2 | 4;
        weight?: number;
    }

Default: {}

§readonly website_id?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getWebsites"}