Interface ShopifyNodeParameters

Source
interface ShopifyNodeParameters {
    additionalFields?:
        | {
            billingAddressUi?: {
                billingAddressValues: {
                    address1?: string;
                    address2?: string;
                    city?: string;
                    company?: string;
                    country?: string;
                    firstName?: string;
                    lastName?: string;
                    phone?: string;
                    province?: string;
                    zip?: string;
                };
            };
            discountCodesUi?: {
                discountCodesValues: {
                    amount?: string;
                    code?: string;
                    type?: "percentage"
                    | "fixedAmount"
                    | "shipping";
                }[];
            };
            email?: string;
            fulfillmentStatus?: | "null"
            | "fulfilled"
            | "partial"
            | "restocked";
            inventoryBehaviour?: | "bypass"
            | "decrementIgnoringPolicy"
            | "decrementObeyingPolicy";
            locationId?: string;
            note?: string;
            sendFulfillmentReceipt?: boolean;
            sendReceipt?: boolean;
            shippingAddressUi?: {
                shippingAddressValues: {
                    address1?: string;
                    address2?: string;
                    city?: string;
                    company?: string;
                    country?: string;
                    firstName?: string;
                    lastName?: string;
                    phone?: string;
                    province?: string;
                    zip?: string;
                };
            };
            sourceName?: string;
            tags?: string;
            test?: boolean;
        }
        | {
            body_html?: string;
            handle?: string;
            images?: {
                created_at?: string;
                height?: number;
                id?: number;
                position?: number;
                product_id?: number;
                src?: string;
                updated_at?: string;
                variant_ids?: number;
                width?: number;
            };
            product_type?: string;
            productOptions?: {
                option: { name?: string; value?: string }[];
            };
            published_at?: string;
            published_scope?: "global"
            | "web";
            tags?: string;
            template_suffix?: string;
            vendor?: string;
        }
        | { fields?: string }
        | {
            collection_id?: string;
            created_at_max?: string;
            created_at_min?: string;
            fields?: string;
            handle?: string;
            ids?: string;
            presentment_currencies?: string;
            product_type?: string;
            published_at_max?: string;
            published_at_min?: string;
            published_status?:
                | "any"
                | "published"
                | "unpublished";
            title?: string;
            updated_at_max?: string;
            updated_at_min?: string;
            vendor?: string;
        };
    authentication?: "apiKey"
    | "oAuth2"
    | "accessToken";
    limeItemsUi?: {
        lineItemValues: {
            grams?: string;
            price?: string;
            productId?: string;
            quantity?: number;
            title?: string;
            variantId?: string;
        }[];
    };
    limit?: number;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    options?: | { fields?: string }
    | {
        attributionAppId?: string;
        createdAtMax?: string;
        createdAtMin?: string;
        fields?: string;
        financialStatus?:
            | "pending"
            | "any"
            | "paid"
            | "unpaid"
            | "authorized"
            | "partiallyPaid"
            | "partiallyRefunded"
            | "refunded"
            | "voided";
        fulfillmentStatus?: | "any"
        | "partial"
        | "shipped"
        | "unfulfilled"
        | "unshipped";
        ids?: string;
        processedAtMax?: string;
        processedAtMin?: string;
        sinceId?: string;
        status?: "open"
        | "closed"
        | "any"
        | "Cancelled";
        updatedAtMax?: string;
        updatedAtMin?: string;
    };
    orderId?: string;
    productId?: string;
    resource?: "product"
    | "order";
    returnAll?: boolean;
    title?: string;
    updateFields?:
        | {
            email?: string;
            locationId?: string;
            note?: string;
            shippingAddressUi?: {
                shippingAddressValues: {
                    address1?: string;
                    address2?: string;
                    city?: string;
                    company?: string;
                    country?: string;
                    firstName?: string;
                    lastName?: string;
                    phone?: string;
                    province?: string;
                    zip?: string;
                };
            };
            sourceName?: string;
            tags?: string;
        }
        | {
            body_html?: string;
            handle?: string;
            images?: {
                created_at?: string;
                height?: number;
                id?: number;
                position?: number;
                product_id?: number;
                src?: string;
                updated_at?: string;
                variant_ids?: number;
                width?: number;
            };
            product_type?: string;
            productOptions?: {
                option: { name?: string; value?: string }[];
            };
            published_at?: string;
            published_scope?: "global"
            | "web";
            tags?: string;
            template_suffix?: string;
            title?: string;
            vendor?: string;
        };
}

Properties§

Source§

readonly additionalFields?:
    | {
        billingAddressUi?: {
            billingAddressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                company?: string;
                country?: string;
                firstName?: string;
                lastName?: string;
                phone?: string;
                province?: string;
                zip?: string;
            };
        };
        discountCodesUi?: {
            discountCodesValues: {
                amount?: string;
                code?: string;
                type?: "percentage"
                | "fixedAmount"
                | "shipping";
            }[];
        };
        email?: string;
        fulfillmentStatus?: | "null"
        | "fulfilled"
        | "partial"
        | "restocked";
        inventoryBehaviour?: | "bypass"
        | "decrementIgnoringPolicy"
        | "decrementObeyingPolicy";
        locationId?: string;
        note?: string;
        sendFulfillmentReceipt?: boolean;
        sendReceipt?: boolean;
        shippingAddressUi?: {
            shippingAddressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                company?: string;
                country?: string;
                firstName?: string;
                lastName?: string;
                phone?: string;
                province?: string;
                zip?: string;
            };
        };
        sourceName?: string;
        tags?: string;
        test?: boolean;
    }
    | {
        body_html?: string;
        handle?: string;
        images?: {
            created_at?: string;
            height?: number;
            id?: number;
            position?: number;
            product_id?: number;
            src?: string;
            updated_at?: string;
            variant_ids?: number;
            width?: number;
        };
        product_type?: string;
        productOptions?: {
            option: { name?: string; value?: string }[];
        };
        published_at?: string;
        published_scope?: "global"
        | "web";
        tags?: string;
        template_suffix?: string;
        vendor?: string;
    }
    | { fields?: string }
    | {
        collection_id?: string;
        created_at_max?: string;
        created_at_min?: string;
        fields?: string;
        handle?: string;
        ids?: string;
        presentment_currencies?: string;
        product_type?: string;
        published_at_max?: string;
        published_at_min?: string;
        published_status?: "any" | "published" | "unpublished";
        title?: string;
        updated_at_max?: string;
        updated_at_min?: string;
        vendor?: string;
    }

Default: {}

Source§

readonly authentication?: "apiKey" | "oAuth2" | "accessToken"

Default: "apiKey"

Source§

readonly limeItemsUi?: {
    lineItemValues: {
        grams?: string;
        price?: string;
        productId?: string;
        quantity?: number;
        title?: string;
        variantId?: string;
    }[];
}

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

Source§

readonly limit?: number

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

Source§

readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "create"

Source§

readonly options?:
    | { fields?: string }
    | {
        attributionAppId?: string;
        createdAtMax?: string;
        createdAtMin?: string;
        fields?: string;
        financialStatus?:
            | "pending"
            | "any"
            | "paid"
            | "unpaid"
            | "authorized"
            | "partiallyPaid"
            | "partiallyRefunded"
            | "refunded"
            | "voided";
        fulfillmentStatus?: | "any"
        | "partial"
        | "shipped"
        | "unfulfilled"
        | "unshipped";
        ids?: string;
        processedAtMax?: string;
        processedAtMin?: string;
        sinceId?: string;
        status?: "open"
        | "closed"
        | "any"
        | "Cancelled";
        updatedAtMax?: string;
        updatedAtMin?: string;
    }

Default: {}

Source§

readonly orderId?: string

Source§

readonly productId?: string

Source§

readonly resource?: "product" | "order"

Default: "order"

Source§

readonly returnAll?: boolean

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

Source§

readonly title?: string

The name of the product

Source§

readonly updateFields?:
    | {
        email?: string;
        locationId?: string;
        note?: string;
        shippingAddressUi?: {
            shippingAddressValues: {
                address1?: string;
                address2?: string;
                city?: string;
                company?: string;
                country?: string;
                firstName?: string;
                lastName?: string;
                phone?: string;
                province?: string;
                zip?: string;
            };
        };
        sourceName?: string;
        tags?: string;
    }
    | {
        body_html?: string;
        handle?: string;
        images?: {
            created_at?: string;
            height?: number;
            id?: number;
            position?: number;
            product_id?: number;
            src?: string;
            updated_at?: string;
            variant_ids?: number;
            width?: number;
        };
        product_type?: string;
        productOptions?: {
            option: { name?: string; value?: string }[];
        };
        published_at?: string;
        published_scope?: "global"
        | "web";
        tags?: string;
        template_suffix?: string;
        title?: string;
        vendor?: string;
    }

Default: {}