Skip to content

Woo Commerce

Node: wooCommerce · Full type: n8n-nodes-base.wooCommerce · Version: 1

Credentials

wooCommerceApi (alias: @woo)

CREDENTIAL @woo = wooCommerceApi "My Woo Commerce"

Operations

Resource: customer

create

Parameter Type Default Details
email string "" required
additionalFields collection {} keys: billing, first_name, last_name, meta_data, password, shipping, ...

delete

Parameter Type Default Details
customerId string "" required

get

Parameter Type Default Details
customerId string "" required

getAll

Parameter Type Default Details
returnAll boolean false
limit number 50
filters collection {} keys: email, order, orderby

update

Parameter Type Default Details
customerId string "" required
updateFields collection {} keys: billing, first_name, last_name, meta_data, password, shipping

Resource: order

create

Parameter Type Default Details
additionalFields collection {} keys: currency, customerId, customerNote, parentId, paymentMethodId, paymentMethodTitle, ...
billingUi fixedCollection {} groups: billingValues
couponLinesUi fixedCollection {} groups: couponLinesValues
feeLinesUi fixedCollection {} groups: feeLinesValues
lineItemsUi fixedCollection {} groups: lineItemsValues
metadataUi fixedCollection {} groups: metadataValues
shippingUi fixedCollection {} groups: shippingValues
shippingLinesUi fixedCollection {} groups: shippingLinesValues

delete

Parameter Type Default Details
orderId string ""

get

Parameter Type Default Details
orderId string ""

getAll

Parameter Type Default Details
returnAll boolean false
limit number 50
options collection {} keys: after, before, customer, decimalPoints, order, product, ...

update

Parameter Type Default Details
orderId string ""
updateFields collection {} keys: currency, customerId, customerNote, parentId, paymentMethodId, paymentMethodTitle, ...
billingUi fixedCollection {} groups: billingValues
couponLinesUi fixedCollection {} groups: couponLinesValues
feeLinesUi fixedCollection {} groups: feeLinesValues
lineItemsUi fixedCollection {} groups: lineItemsValues
metadataUi fixedCollection {} groups: metadataValues
shippingUi fixedCollection {} groups: shippingValues
shippingLinesUi fixedCollection {} groups: shippingLinesValues

Resource: product

create

Parameter Type Default Details
name string "" required
additionalFields collection {} keys: backorders, buttonText, catalogVisibility, categories, crossSellIds, dateOnSaleFrom, ...
dimensionsUi fixedCollection {} groups: dimensionsValues
imagesUi fixedCollection {} groups: imagesValues
metadataUi fixedCollection {} groups: metadataValues

delete

Parameter Type Default Details
productId string ""

get

Parameter Type Default Details
productId string ""

getAll

Parameter Type Default Details
returnAll boolean false
limit number 50
options collection {} keys: after, before, category, context, featured, maxPrice, ...

update

Parameter Type Default Details
productId string ""
updateFields collection {} keys: backorders, buttonText, catalogVisibility, categories, crossSellIds, dateOnSaleFrom, ...
dimensionsUi fixedCollection {} groups: dimensionsValues
imagesUi fixedCollection {} groups: imagesValues
metadataUi fixedCollection {} groups: metadataValues

Parameter Details

additionalFields children:

Parameter Type Default Details
billing collection {} keys: first_name, last_name, company, address_1, address_2, city, ...
first_name string ""
last_name string ""
meta_data fixedCollection {} groups: meta_data_fields
password string ""
shipping collection {} keys: first_name, last_name, company, address_1, address_2, city, ...
username string ""

filters children:

Parameter Type Default Details
email string ""
order options "asc" asc, desc
orderby options "id" id, include, name, registered_date

updateFields children:

Parameter Type Default Details
billing collection {} keys: first_name, last_name, company, address_1, address_2, city, ...
first_name string ""
last_name string ""
meta_data fixedCollection {} groups: meta_data_fields
password string ""
shipping collection {} keys: first_name, last_name, company, address_1, address_2, city, ...

dimensionsUi children:

dimensionsValues group:

Parameter Type Default Details
height string ""
length string ""
width string ""

imagesUi children:

imagesValues group:

Parameter Type Default Details
alt string ""
src string ""
name string ""

metadataUi children:

metadataValues group:

Parameter Type Default Details
key string ""
value string ""

options children:

Parameter Type Default Details
after dateTime ""
before dateTime ""
category options ""
context options "view" view, embed, edit
featured boolean false
maxPrice string ""
minPrice string ""
order options "desc" asc, desc
orderBy options "id" date, id, include, slug, title
search string ""
sku string ""
slug string ""
status options "any" any, draft, pending, private, publish
stockStatus options "" instock, outofstock, onbackorder
tag options []
taxClass options "" standard, reduced-rate, zero-rate.
type options "simple" simple, grouped, external, variable

billingUi children:

billingValues group:

Parameter Type Default Details
firstName string ""
lastName string ""
company string ""
address_1 string ""
address_2 string ""
city string ""
postcode string ""
country string ""
email string ""
phone string ""

couponLinesUi children:

couponLinesValues group:

Parameter Type Default Details
code string ""
metadataUi fixedCollection {} groups: metadataValues

feeLinesUi children:

feeLinesValues group:

Parameter Type Default Details
name string ""
taxClass string ""
taxStatus options "" taxable, none
total string ""
metadataUi fixedCollection {} groups: metadataValues

lineItemsUi children:

lineItemsValues group:

Parameter Type Default Details
name string ""
productId number 0
variationId number 0
quantity number 1
taxClass string ""
subtotal string ""
total string ""
metadataUi fixedCollection {} groups: metadataValues

shippingUi children:

shippingValues group:

Parameter Type Default Details
firstName string ""
lastName string ""
company string ""
address_1 string ""
address_2 string ""
city string ""
postcode string ""
country string ""

shippingLinesUi children:

shippingLinesValues group:

Parameter Type Default Details
methodTitle string ""
method ID string ""
total string ""
metadataUi fixedCollection {} groups: metadataValues

Example

NODE "wooCommerce" @woo AS "Woo Commerce" {
  resource: "customer",
  operation: "get",
  email: {{ $json.email }},
  customerId: {{ $json.customerId }},
  name: {{ $json.name }}
}