interface WooCommerceNodeParameters {
additionalFields?:
| {
billing?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
first_name?: string;
last_name?: string;
meta_data?: {
meta_data_fields: {
key?: string;
value?: string;
}[];
};
password?: string;
shipping?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
username?: string;
}
| {
backorders?: "yes"
| "no"
| "notify";
buttonText?: string;
catalogVisibility?:
| "search"
| "hidden"
| "catalog"
| "visible";
categories?: unknown[];
crossSellIds?: string;
dateOnSaleFrom?: string;
dateOnSaleTo?: string;
description?: string;
downloadable?: boolean;
externalUrl?: string;
featured?: boolean;
manageStock?: boolean;
menuOrder?: number;
parentId?: string;
purchaseNote?: string;
regularPrice?: string;
reviewsAllowed?: boolean;
salePrice?: string;
shippingClass?: string;
shortDescription?: string;
sku?: string;
slug?: string;
soldIndividually?: boolean;
status?: "private"
| "publish"
| "pending"
| "draft";
stockQuantity?: number;
stockStatus?:
| "instock"
| "outofstock"
| "onbackorder";
tags?: unknown[];
taxClass?: string;
taxStatus?: "none"
| "shipping"
| "taxable";
type?: "simple" | "grouped" | "external" | "variable";
upsellIds?: string;
virtual?: boolean;
weight?: string;
}
| {
currency?: string;
customerId?: string;
customerNote?: string;
parentId?: string;
paymentMethodId?: string;
paymentMethodTitle?: string;
setPaid?: boolean;
status?: | "pending"
| "cancelled"
| "completed"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
transactionID?: string;
};
billingUi?: | {
billingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
firstName?: string;
lastName?: string;
phone?: string;
postcode?: string;
};
}
| {
billingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
firstName?: string;
lastName?: string;
phone?: string;
postalCode?: string;
};
};
couponLinesUi?: {
couponLinesValues: {
code?: string;
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
}[];
};
customerId?: string;
dimensionsUi?: {
dimensionsValues: {
height?: string;
length?: string;
width?: string;
};
};
email?: string;
feeLinesUi?: {
feeLinesValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
name?: string;
taxClass?: string;
taxStatus?: "none"
| "taxable";
total?: string;
}[];
};
filters?: {
email?: string;
order?: "asc"
| "desc";
orderby?:
| "id"
| "name"
| "include"
| "registered_date";
};
imagesUi?: {
imagesValues: {
alt?: string;
name?: string;
src?: string;
}[];
};
limit?: number;
lineItemsUi?: {
lineItemsValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
name?: string;
productId?: number;
quantity?: number;
subtotal?: string;
taxClass?: string;
total?: string;
variationId?: number;
}[];
};
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
name?: string;
operation?: | "create"
| "get"
| "getAll"
| "update"
| "delete";
options?: | {
after?: string;
before?: string;
category?: string;
context?: "edit"
| "view"
| "embed";
featured?: boolean;
maxPrice?: string;
minPrice?: string;
order?: "asc" | "desc";
orderBy?: "id" | "date" | "slug" | "title" | "include";
search?: string;
sku?: string;
slug?: string;
status?:
| "private"
| "publish"
| "pending"
| "any"
| "draft";
stockStatus?: "instock"
| "outofstock"
| "onbackorder";
tag?: string;
taxClass?: "standard" | "reduced-rate" | "zero-rate.";
type?: "simple" | "grouped" | "external" | "variable";
}
| {
after?: string;
before?: string;
customer?: string;
decimalPoints?: number;
order?: "asc"
| "desc";
orderBy?: "id" | "date" | "slug" | "title" | "include";
product?: string;
search?: string;
status?:
| "pending"
| "cancelled"
| "completed"
| "any"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
};
orderId?: string;
productId?: string;
resource?: "customer"
| "product"
| "order";
returnAll?: boolean;
shippingLinesUi?: {
shippingLinesValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
"method ID"?: string;
methodTitle?: string;
total?: string;
}[];
};
shippingUi?: | {
shippingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
firstName?: string;
lastName?: string;
postcode?: string;
};
}
| {
shippingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
firstName?: string;
lastName?: string;
postalCode?: string;
};
};
updateFields?: | {
billing?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
first_name?: string;
last_name?: string;
meta_data?: {
meta_data_fields: { key?: string; value?: string }[];
};
password?: string;
shipping?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
}
| {
backorders?: "yes"
| "no"
| "notify";
buttonText?: string;
catalogVisibility?:
| "search"
| "hidden"
| "catalog"
| "visible";
categories?: unknown[];
crossSellIds?: string;
dateOnSaleFrom?: string;
dateOnSaleTo?: string;
description?: string;
downloadable?: boolean;
externalUrl?: string;
featured?: boolean;
manageStock?: boolean;
menuOrder?: number;
name?: string;
parentId?: string;
purchaseNote?: string;
regularPrice?: string;
reviewsAllowed?: boolean;
salePrice?: string;
shippingClass?: string;
shortDescription?: string;
sku?: string;
slug?: string;
soldIndividually?: boolean;
status?: "private"
| "publish"
| "pending"
| "draft";
stockQuantity?: number;
stockStatus?: "instock" | "outofstock" | "onbackorder";
tags?: unknown[];
taxClass?: string;
taxStatus?: "none" | "shipping" | "taxable";
type?: "simple" | "grouped" | "external" | "variable";
upsellIds?: string;
virtual?: boolean;
weight?: string;
}
| {
currency?: string;
customerId?: string;
customerNote?: string;
parentId?: string;
paymentMethodId?: string;
paymentMethodTitle?: string;
status?: | "pending"
| "cancelled"
| "completed"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
transactionID?: string;
};
}
Properties§
Source§readonly additional Fields?:
| {
billing?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
first_name?: string;
last_name?: string;
meta_data?: {
meta_data_fields: { key?: string; value?: string }[];
};
password?: string;
shipping?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
username?: string;
}
| {
backorders?: "yes"
| "no"
| "notify";
buttonText?: string;
catalogVisibility?:
| "search"
| "hidden"
| "catalog"
| "visible";
categories?: unknown[];
crossSellIds?: string;
dateOnSaleFrom?: string;
dateOnSaleTo?: string;
description?: string;
downloadable?: boolean;
externalUrl?: string;
featured?: boolean;
manageStock?: boolean;
menuOrder?: number;
parentId?: string;
purchaseNote?: string;
regularPrice?: string;
reviewsAllowed?: boolean;
salePrice?: string;
shippingClass?: string;
shortDescription?: string;
sku?: string;
slug?: string;
soldIndividually?: boolean;
status?: "private"
| "publish"
| "pending"
| "draft";
stockQuantity?: number;
stockStatus?: "instock" | "outofstock" | "onbackorder";
tags?: unknown[];
taxClass?: string;
taxStatus?: "none" | "shipping" | "taxable";
type?: "simple" | "grouped" | "external" | "variable";
upsellIds?: string;
virtual?: boolean;
weight?: string;
}
| {
currency?: string;
customerId?: string;
customerNote?: string;
parentId?: string;
paymentMethodId?: string;
paymentMethodTitle?: string;
setPaid?: boolean;
status?: | "pending"
| "cancelled"
| "completed"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
transactionID?: string;
}
readonly additional Fields?:
| {
billing?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
first_name?: string;
last_name?: string;
meta_data?: {
meta_data_fields: { key?: string; value?: string }[];
};
password?: string;
shipping?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
username?: string;
}
| {
backorders?: "yes"
| "no"
| "notify";
buttonText?: string;
catalogVisibility?:
| "search"
| "hidden"
| "catalog"
| "visible";
categories?: unknown[];
crossSellIds?: string;
dateOnSaleFrom?: string;
dateOnSaleTo?: string;
description?: string;
downloadable?: boolean;
externalUrl?: string;
featured?: boolean;
manageStock?: boolean;
menuOrder?: number;
parentId?: string;
purchaseNote?: string;
regularPrice?: string;
reviewsAllowed?: boolean;
salePrice?: string;
shippingClass?: string;
shortDescription?: string;
sku?: string;
slug?: string;
soldIndividually?: boolean;
status?: "private"
| "publish"
| "pending"
| "draft";
stockQuantity?: number;
stockStatus?: "instock" | "outofstock" | "onbackorder";
tags?: unknown[];
taxClass?: string;
taxStatus?: "none" | "shipping" | "taxable";
type?: "simple" | "grouped" | "external" | "variable";
upsellIds?: string;
virtual?: boolean;
weight?: string;
}
| {
currency?: string;
customerId?: string;
customerNote?: string;
parentId?: string;
paymentMethodId?: string;
paymentMethodTitle?: string;
setPaid?: boolean;
status?: | "pending"
| "cancelled"
| "completed"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
transactionID?: string;
}
Source§readonly billing Ui?:
| {
billingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
firstName?: string;
lastName?: string;
phone?: string;
postcode?: string;
};
}
| {
billingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
firstName?: string;
lastName?: string;
phone?: string;
postalCode?: string;
};
}
readonly billing Ui?:
| {
billingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
firstName?: string;
lastName?: string;
phone?: string;
postcode?: string;
};
}
| {
billingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
firstName?: string;
lastName?: string;
phone?: string;
postalCode?: string;
};
}
Billing address Default: {} Type options: {"multipleValues":false}
Source§readonly coupon Lines Ui?: {
couponLinesValues: {
code?: string;
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
}[];
}
readonly coupon Lines Ui?: {
couponLinesValues: {
code?: string;
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
}[];
}
Coupons line data Default: {} Type options: {"multipleValues":true}
Source§readonly dimensions Ui?: {
dimensionsValues: {
height?: string;
length?: string;
width?: string;
};
}
readonly dimensions Ui?: {
dimensionsValues: {
height?: string;
length?: string;
width?: string;
};
}
Product dimensions Default: {} Type options: {"multipleValues":false}
Source§readonly fee Lines Ui?: {
feeLinesValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
name?: string;
taxClass?: string;
taxStatus?: "none"
| "taxable";
total?: string;
}[];
}
readonly fee Lines Ui?: {
feeLinesValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
name?: string;
taxClass?: string;
taxStatus?: "none"
| "taxable";
total?: string;
}[];
}
Fee line data Default: {} Type options: {"multipleValues":true}
Source§readonly filters?: {
email?: string;
order?: "asc" | "desc";
orderby?: "id" | "name" | "include" | "registered_date";
}
readonly filters?: {
email?: string;
order?: "asc" | "desc";
orderby?: "id" | "name" | "include" | "registered_date";
}
Default: {}
Source§readonly images Ui?: {
imagesValues: {
alt?: string;
name?: string;
src?: string;
}[];
}
readonly images Ui?: {
imagesValues: {
alt?: string;
name?: string;
src?: string;
}[];
}
Product Image Default: {} Type options: {"multipleValues":true}
Source§readonly limit?: number
readonly limit?: number
Max number of results to return Default: 50 Type options: {"minValue":1}
Source§readonly line Items Ui?: {
lineItemsValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
name?: string;
productId?: number;
quantity?: number;
subtotal?: string;
taxClass?: string;
total?: string;
variationId?: number;
}[];
}
readonly line Items Ui?: {
lineItemsValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
name?: string;
productId?: number;
quantity?: number;
subtotal?: string;
taxClass?: string;
total?: string;
variationId?: number;
}[];
}
Line item data Default: {} Type options: {"multipleValues":true}
Source§readonly metadata Ui?: { metadataValues: { key?: string; value?: string }[] }
readonly metadata Ui?: { metadataValues: { key?: string; value?: string }[] }
Meta data Default: {} Type options: {"multipleValues":true}
Source§readonly options?:
| {
after?: string;
before?: string;
category?: string;
context?: "edit"
| "view"
| "embed";
featured?: boolean;
maxPrice?: string;
minPrice?: string;
order?: "asc" | "desc";
orderBy?: "id" | "date" | "slug" | "title" | "include";
search?: string;
sku?: string;
slug?: string;
status?:
| "private"
| "publish"
| "pending"
| "any"
| "draft";
stockStatus?: "instock"
| "outofstock"
| "onbackorder";
tag?: string;
taxClass?: "standard" | "reduced-rate" | "zero-rate.";
type?: "simple" | "grouped" | "external" | "variable";
}
| {
after?: string;
before?: string;
customer?: string;
decimalPoints?: number;
order?: "asc"
| "desc";
orderBy?: "id" | "date" | "slug" | "title" | "include";
product?: string;
search?: string;
status?:
| "pending"
| "cancelled"
| "completed"
| "any"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
}
readonly options?:
| {
after?: string;
before?: string;
category?: string;
context?: "edit"
| "view"
| "embed";
featured?: boolean;
maxPrice?: string;
minPrice?: string;
order?: "asc" | "desc";
orderBy?: "id" | "date" | "slug" | "title" | "include";
search?: string;
sku?: string;
slug?: string;
status?:
| "private"
| "publish"
| "pending"
| "any"
| "draft";
stockStatus?: "instock"
| "outofstock"
| "onbackorder";
tag?: string;
taxClass?: "standard" | "reduced-rate" | "zero-rate.";
type?: "simple" | "grouped" | "external" | "variable";
}
| {
after?: string;
before?: string;
customer?: string;
decimalPoints?: number;
order?: "asc"
| "desc";
orderBy?: "id" | "date" | "slug" | "title" | "include";
product?: string;
search?: string;
status?:
| "pending"
| "cancelled"
| "completed"
| "any"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
}
Default: {}
Source§readonly shipping Lines Ui?: {
shippingLinesValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
"method ID"?: string;
methodTitle?: string;
total?: string;
}[];
}
readonly shipping Lines Ui?: {
shippingLinesValues: {
metadataUi?: {
metadataValues: { key?: string; value?: string }[];
};
"method ID"?: string;
methodTitle?: string;
total?: string;
}[];
}
Shipping line data Default: {} Type options: {"multipleValues":true}
Source§readonly shipping Ui?:
| {
shippingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
firstName?: string;
lastName?: string;
postcode?: string;
};
}
| {
shippingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
firstName?: string;
lastName?: string;
postalCode?: string;
};
}
readonly shipping Ui?:
| {
shippingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
firstName?: string;
lastName?: string;
postcode?: string;
};
}
| {
shippingValues: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
firstName?: string;
lastName?: string;
postalCode?: string;
};
}
Shipping address Default: {} Type options: {"multipleValues":false}
Source§readonly update Fields?:
| {
billing?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
first_name?: string;
last_name?: string;
meta_data?: {
meta_data_fields: { key?: string; value?: string }[];
};
password?: string;
shipping?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
}
| {
backorders?: "yes"
| "no"
| "notify";
buttonText?: string;
catalogVisibility?:
| "search"
| "hidden"
| "catalog"
| "visible";
categories?: unknown[];
crossSellIds?: string;
dateOnSaleFrom?: string;
dateOnSaleTo?: string;
description?: string;
downloadable?: boolean;
externalUrl?: string;
featured?: boolean;
manageStock?: boolean;
menuOrder?: number;
name?: string;
parentId?: string;
purchaseNote?: string;
regularPrice?: string;
reviewsAllowed?: boolean;
salePrice?: string;
shippingClass?: string;
shortDescription?: string;
sku?: string;
slug?: string;
soldIndividually?: boolean;
status?: "private"
| "publish"
| "pending"
| "draft";
stockQuantity?: number;
stockStatus?: "instock" | "outofstock" | "onbackorder";
tags?: unknown[];
taxClass?: string;
taxStatus?: "none" | "shipping" | "taxable";
type?: "simple" | "grouped" | "external" | "variable";
upsellIds?: string;
virtual?: boolean;
weight?: string;
}
| {
currency?: string;
customerId?: string;
customerNote?: string;
parentId?: string;
paymentMethodId?: string;
paymentMethodTitle?: string;
status?: | "pending"
| "cancelled"
| "completed"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
transactionID?: string;
}
readonly update Fields?:
| {
billing?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
first_name?: string;
last_name?: string;
meta_data?: {
meta_data_fields: { key?: string; value?: string }[];
};
password?: string;
shipping?: {
address_1?: string;
address_2?: string;
city?: string;
company?: string;
country?: string;
email?: string;
first_name?: string;
last_name?: string;
phone?: string;
postcode?: string;
state?: string;
};
}
| {
backorders?: "yes"
| "no"
| "notify";
buttonText?: string;
catalogVisibility?:
| "search"
| "hidden"
| "catalog"
| "visible";
categories?: unknown[];
crossSellIds?: string;
dateOnSaleFrom?: string;
dateOnSaleTo?: string;
description?: string;
downloadable?: boolean;
externalUrl?: string;
featured?: boolean;
manageStock?: boolean;
menuOrder?: number;
name?: string;
parentId?: string;
purchaseNote?: string;
regularPrice?: string;
reviewsAllowed?: boolean;
salePrice?: string;
shippingClass?: string;
shortDescription?: string;
sku?: string;
slug?: string;
soldIndividually?: boolean;
status?: "private"
| "publish"
| "pending"
| "draft";
stockQuantity?: number;
stockStatus?: "instock" | "outofstock" | "onbackorder";
tags?: unknown[];
taxClass?: string;
taxStatus?: "none" | "shipping" | "taxable";
type?: "simple" | "grouped" | "external" | "variable";
upsellIds?: string;
virtual?: boolean;
weight?: string;
}
| {
currency?: string;
customerId?: string;
customerNote?: string;
parentId?: string;
paymentMethodId?: string;
paymentMethodTitle?: string;
status?: | "pending"
| "cancelled"
| "completed"
| "trash"
| "refunded"
| "failed"
| "processing"
| "on-hold";
transactionID?: string;
}
Default: {}
Default: {}