Magento 2

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

Credentials

magento2Api (alias: @magento)

CREDENTIAL @magento = magento2Api "My Magento 2"

Operations

Resource: customer

create

Parameter	Type	Default	Details
email	string	""	required
firstname	string	""	required
lastname	string	""	required
additionalFields	collection	{}	keys: addresses, amazon_id, confirmation, customAttributes, dob, default_billing, ...

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	5
filterType	options	"none"	none, manual, json
matchType	options	"anyFilter"	anyFilter, allFilters
filters	fixedCollection	{}	groups: conditions
filterJson	string	""
options	collection	{}	keys: sort

update

Parameter	Type	Default	Details
customerId	string	""
email	string	""
firstName	string	""
lastName	string	""
website_id	options	""
updateFields	collection	{}	keys: addresses, amazon_id, confirmation, customAttributes, dob, default_billing, ...

Resource: invoice

create

Parameter	Type	Default	Details
orderId	string	""	required

Resource: order

cancel

Parameter	Type	Default	Details
orderId	string	""	required

get

Parameter	Type	Default	Details
orderId	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	5
filterType	options	"none"	none, manual, json
matchType	options	"anyFilter"	anyFilter, allFilters
filters	fixedCollection	{}	groups: conditions
filterJson	string	""
options	collection	{}	keys: sort

ship

Parameter	Type	Default	Details
orderId	string	""	required

Resource: product

create

Parameter	Type	Default	Details
sku	string	""	required
name	string	""	required
attributeSetId	options	""
price	number	0
additionalFields	collection	{}	keys: attribute_set_id, name, price, status, type_id, visibility, ...

delete

Parameter	Type	Default	Details
sku	string	""	required

get

Parameter	Type	Default	Details
sku	string	""	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	5
filterType	options	"none"	none, manual, json
matchType	options	"anyFilter"	anyFilter, allFilters
filters	fixedCollection	{}	groups: conditions
filterJson	string	""
options	collection	{}	keys: sort

update

Parameter	Type	Default	Details
sku	string	""	required
updateFields	collection	{}	keys: attribute_set_id, name, price, status, type_id, visibility, ...

Parameter Details

additionalFields children:

Parameter	Type	Default	Details
addresses	fixedCollection	{}	groups: address
amazon_id	string	""
confirmation	string	""
customAttributes	fixedCollection	{}	groups: customAttribute
dob	dateTime	""
default_billing	string	""
default_shipping	string	""
gender	options	""	1, 2, 3
group_id	options	""
is_subscribed	boolean	false
middlename	string	""
password	string	""
prefix	string	""
store_id	options	""
suffix	string	""
vertex_customer_code	string	""
vertex_customer_country	string	""
website_id	options	""

updateFields children:

Parameter	Type	Default	Details
addresses	fixedCollection	{}	groups: address
amazon_id	string	""
confirmation	string	""
customAttributes	fixedCollection	{}	groups: customAttribute
dob	dateTime	""
default_billing	string	""
default_shipping	string	""
gender	options	""	1, 2, 3
group_id	options	""
is_subscribed	boolean	false
middlename	string	""
password	string	""
prefix	string	""
store_id	options	""
suffix	string	""
vertex_customer_code	string	""
vertex_customer_country	string	""
website_id	options	""

filters children:

conditions group:

Parameter	Type	Default	Details
field	options	""
condition_type	options	"eq"	eq, gt, gteq, in, lt, lte, like, moreq, ... (12 total)
value	string	""

options children:

Parameter	Type	Default	Details
sort	fixedCollection	[]	groups: sort

Example

NODE "magento2" @magento AS "Magento 2" {
  resource: "customer",
  operation: "get",
  email: {{ $json.email }},
  firstname: {{ $json.firstname }},
  lastname: {{ $json.lastname }}
}