Magento
App · 21 actions
Run a Magento store from your workflows: find orders and comment on, invoice, ship or cancel them, manage customers and customer groups, and create and update products with their prices and stock.
Actions
| Action | What it does |
|---|---|
| Add order comment | Add a comment to an order's history, optionally emailing it to the customer or showing it in their account. |
| Cancel order | Cancel an order that hasn't been invoiced or shipped in full. |
| Create customer | Create a customer account, optionally with an address used for both billing and shipping. |
| Create customer group | Create a customer group, such as Wholesale, for its own prices, discounts and tax class. |
| Create product | Create a simple or virtual product with its price, stock, categories and descriptions. |
| Delete customer | Delete a customer account and its addresses for good. |
| Delete customer group | Delete a customer group. |
| Delete product | Delete a product for good. |
| Get customer | Get one customer account with its group, newsletter subscription and saved addresses. |
| Get customer group | Get one customer group with its tax class. |
| Get order | Get one order with its items, totals, addresses, payment and shipping method and comments, by its id or its order number. |
| Get product | Get one product by its SKU, with its price, stock, status, websites, categories and every other attribute. |
| Invoice order | Invoice everything on an order not yet invoiced. |
| List customer groups | List customer groups with their tax classes, optionally only those whose name contains some text. |
| List customers | List customer accounts, oldest first, filtered by email, group or when they were created or last changed. |
| List orders | List orders, newest first, filtered by status, customer or when they were placed or last changed. |
| List products | List products, oldest first, filtered by name, SKU, type, status or when they last changed. |
| Ship order | Ship everything on an order not yet shipped, with a tracking number if you have one. |
| Update customer | Change a customer's email, name, group, date of birth, gender, tax number or newsletter subscription. |
| Update customer group | Rename a customer group or change its tax class. |
| Update product | Change a product's name, price, stock, status, visibility, websites, categories or descriptions. |
Add order comment
Add a comment to an order's history, optionally emailing it to the customer or showing it in their account. The order's status stays as it is.
Inputs
- Order ID
order_idtextRequired - The order's id: 'id' from 'List orders' or 'Get order', or the number after order_id/ in the admin's address for the order. It isn't the order number customers see.
- Comment
commenttextRequired - The comment's text.
- Email the customer
notify_customertrue/false - Send the customer Magento's email about it. Off by default.
- Show in the customer's account
visible_to_customertrue/false - Show the comment on the order in the customer's account. Off by default, so only the admin sees it.
Outputs
addedtrue/false- Always true once added
commenttext- The comment added
increment_idtext- The order number customers see
is_customer_notifiedtrue/false- True when the customer was emailed
is_visible_on_fronttrue/false- True when the customer sees it in their account
order_idnumber- The order's id
statustext- The order's status, which the comment keeps
Example output
{
"added": true,
"comment": "Packed and ready.",
"increment_id": "000000123",
"is_customer_notified": false,
"is_visible_on_front": false,
"order_id": 123,
"status": "processing"
}Cancel order
Cancel an order that hasn't been invoiced or shipped in full. It can't be undone.
Inputs
- Order ID
order_idtextRequired - The order's id: 'id' from 'List orders' or 'Get order', or the number after order_id/ in the admin's address for the order. It isn't the order number customers see.
Outputs
canceledtrue/false- Always true once canceled
orderobject- The order, now canceled
Example output
{
"canceled": true,
"order": {
"billing_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"comments": [
{
"comment": "Packed and ready.",
"created_at": "2026-10-20 15:10:42",
"is_customer_notified": false,
"is_visible_on_front": false,
"status": "processing"
}
],
"created_at": "2026-10-20 14:03:11",
"currency": "USD",
"customer_email": "jo@example.com",
"customer_firstname": "Jo",
"customer_group_id": 1,
"customer_id": 45,
"customer_is_guest": false,
"customer_lastname": "Bloggs",
"discount_amount": 0.0,
"grand_total": 59.0,
"id": 123,
"increment_id": "000000123",
"items": [
{
"discount_amount": 0.0,
"item_id": 301,
"name": "Blue mug",
"original_price": 24.5,
"parent_item_id": null,
"price": 24.5,
"product_id": 12,
"product_type": "simple",
"qty_canceled": 0,
"qty_invoiced": 2,
"qty_ordered": 2,
"qty_refunded": 0,
"qty_shipped": 0,
"row_total": 49.0,
"sku": "MUG-BLUE",
"tax_amount": 0.0
}
],
"payment_method": "checkmo",
"shipping_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"shipping_amount": 10.0,
"shipping_description": "Flat Rate - Fixed",
"shipping_method": "flatrate_flatrate",
"state": "canceled",
"status": "canceled",
"store_id": 1,
"subtotal": 49.0,
"tax_amount": 0.0,
"total_due": 0.0,
"total_paid": 59.0,
"total_qty_ordered": 2,
"total_refunded": 0.0,
"updated_at": "2026-10-20 15:10:42"
}
}Create customer
Create a customer account, optionally with an address used for both billing and shipping. Magento emails the customer as it does for a sign-up, and they set their password with Forgot Your Password?.
Inputs
- Email
emailtextRequired - The customer's email address, which they sign in with.
- First name
firstnametextRequired - The customer's first name.
- Last name
lastnametextRequired - The customer's last name.
- Customer group
group_idtext - The customer's group. Defaults to the store's default group.
- Website
website_idtext - The website the account belongs to. Defaults to the store's main website.
- Date of birth
dobdate - The customer's date of birth.
- Gender
gendertext - The customer's gender, as the admin records it.One of:
male,female,not_specified(Not Specified). - Tax/VAT number
taxvattext - The customer's tax or VAT number.
- Newsletter
is_subscribedtrue/false - On subscribes the customer to the store's newsletter, off unsubscribes them.
- Street address
streettext - The street address, one line per line. Give it with City, Country and Phone to save an address; leave every address field empty for none.
- City
citytext - The address's city.
- State/Province
regiontext - The state, province or region, by name or code (such as CA or California). Needed in countries where Magento requires one.
- Zip/Postal code
postcodetext - The address's postal code.
- Country
country_idtext - The address's country. Pick one, or give its two-letter code.
- Phone number
telephonetext - The address's phone number.
- Company
companytext - The company at the address.
Outputs
customerobject- The customer
Example output
{
"customer": {
"addresses": [
{
"city": "Austin",
"company": "Acme",
"country_id": "US",
"default_billing": true,
"default_shipping": true,
"firstname": "Jo",
"id": 7,
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
}
],
"created_at": "2026-09-01 10:00:00",
"created_in": "Default Store View",
"custom_attributes": {},
"default_billing": 7,
"default_shipping": 7,
"dob": "1990-04-01",
"email": "jo@example.com",
"firstname": "Jo",
"gender": "not_specified",
"group_id": 1,
"id": 45,
"is_subscribed": false,
"lastname": "Bloggs",
"middlename": null,
"prefix": null,
"store_id": 1,
"suffix": null,
"taxvat": null,
"updated_at": "2026-10-20 14:03:11",
"website_id": 1
}
}Create customer group
Create a customer group, such as Wholesale, for its own prices, discounts and tax class.
Inputs
- Group name
codetextRequired - The group's name, up to 32 characters. It must be unique.
- Tax class
tax_class_idtext - The customer tax class its members are taxed under. Defaults to the default group's, usually Retail Customer.
Outputs
customer_groupobject- The customer group
Example output
{
"customer_group": {
"code": "Wholesale",
"id": 4,
"tax_class_id": 3,
"tax_class_name": "Retail Customer"
}
}Create product
Create a simple or virtual product with its price, stock, categories and descriptions. A SKU that's already in use is refused.
Inputs
- SKU
skutextRequired - The new product's SKU, up to 64 characters.
- Name
nametextRequired - The product's name.
- Price
pricenumberRequired - The price, in the store's base currency.At least 0.
- Type
type_idtext - Simple (the default) for something that ships, virtual for something that doesn't.One of:
simple(Simple: a physical item that ships (default)),virtual(Virtual: a service or other item that doesn't ship). - Attribute set
attribute_set_idtext - The product's attribute set. Defaults to the one named Default.
- Status
statustext - Enabled products can be bought. New products are enabled.One of:
enabled,disabled. - Visibility
visibilitytext - Where shoppers find it: in the catalog, in search, both, or neither (for a product sold only as part of another). New products show in both.One of:
catalog_search(Catalog, Search),catalog,search,not_visible(Not Visible Individually). - Weight
weightnumber - The weight, in the store's weight unit. Not for virtual products.At least 0.
- Quantity
quantitynumber - How many are in stock. It is in stock when above 0. New products start at 0, so give one to make it buyable.At least 0.
- Websites
website_idslist - Which websites sell it. A new product is sold on all of them unless you choose.
- Categories
category_idslist - Which categories to file it under. Pick from the store's, or type ids.
- Description
descriptiontext - The product page's description. HTML is allowed.
- Short description
short_descriptiontext - The short description shown near the price. HTML is allowed.
- URL key
url_keytext - The product page's address within the store, such as blue-mug. Magento makes one from the name when it's empty.
Outputs
productobject- The product
Example output
{
"product": {
"attribute_set_id": 4,
"category_ids": [
3
],
"created_at": "2026-08-01 09:00:00",
"custom_attributes": {
"tax_class_id": "2"
},
"description": "<p>A blue mug.</p>",
"id": 12,
"is_in_stock": true,
"name": "Blue mug",
"price": 24.5,
"quantity": 40,
"short_description": null,
"sku": "MUG-BLUE",
"special_price": null,
"status": "enabled",
"type_id": "simple",
"updated_at": "2026-10-20 12:00:00",
"url_key": "blue-mug",
"visibility": "catalog_search",
"website_ids": [
1
],
"weight": 0.4
}
}Delete customer
Delete a customer account and its addresses for good. Their orders stay.
Inputs
- Customer ID
customer_idtextRequired - The customer's id, from 'List customers' or an earlier step.
Outputs
customer_idnumber- The customer deleted
deletedtrue/false- Always true once deleted
Example output
{
"customer_id": 45,
"deleted": true
}Delete customer group
Delete a customer group. Magento moves its customers to the default group. A website's default group can't be deleted.
Inputs
- Customer group
group_idtextRequired - The customer group. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
group_idnumber- The group deleted
Example output
{
"deleted": true,
"group_id": 4
}Delete product
Delete a product for good. Orders that include it keep their lines.
Inputs
- SKU
skutextRequired - The product's SKU, exactly as in Magento.
Outputs
deletedtrue/false- Always true once deleted
skutext- The SKU of the product deleted
Example output
{
"deleted": true,
"sku": "MUG-BLUE"
}Get customer
Get one customer account with its group, newsletter subscription and saved addresses.
Inputs
- Customer ID
customer_idtextRequired - The customer's id, from 'List customers' or an earlier step.
Outputs
customerobject- The customer
Example output
{
"customer": {
"addresses": [
{
"city": "Austin",
"company": "Acme",
"country_id": "US",
"default_billing": true,
"default_shipping": true,
"firstname": "Jo",
"id": 7,
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
}
],
"created_at": "2026-09-01 10:00:00",
"created_in": "Default Store View",
"custom_attributes": {},
"default_billing": 7,
"default_shipping": 7,
"dob": "1990-04-01",
"email": "jo@example.com",
"firstname": "Jo",
"gender": "not_specified",
"group_id": 1,
"id": 45,
"is_subscribed": false,
"lastname": "Bloggs",
"middlename": null,
"prefix": null,
"store_id": 1,
"suffix": null,
"taxvat": null,
"updated_at": "2026-10-20 14:03:11",
"website_id": 1
}
}Get customer group
Get one customer group with its tax class.
Inputs
- Customer group
group_idtextRequired - The customer group. Pick one, or give its id from an earlier step.
Outputs
customer_groupobject- The customer group
Example output
{
"customer_group": {
"code": "Wholesale",
"id": 4,
"tax_class_id": 3,
"tax_class_name": "Retail Customer"
}
}Get order
Get one order with its items, totals, addresses, payment and shipping method and comments, by its id or its order number.
Inputs
- Order ID
order_idtext - The order's id, from 'List orders' or an earlier step. Leave empty to find the order by its number instead.
- Order number
order_numbertext - The order number customers see, such as 000000123. Used when no order ID is given.
Outputs
orderobject- The order
Example output
{
"order": {
"billing_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"comments": [
{
"comment": "Packed and ready.",
"created_at": "2026-10-20 15:10:42",
"is_customer_notified": false,
"is_visible_on_front": false,
"status": "processing"
}
],
"created_at": "2026-10-20 14:03:11",
"currency": "USD",
"customer_email": "jo@example.com",
"customer_firstname": "Jo",
"customer_group_id": 1,
"customer_id": 45,
"customer_is_guest": false,
"customer_lastname": "Bloggs",
"discount_amount": 0.0,
"grand_total": 59.0,
"id": 123,
"increment_id": "000000123",
"items": [
{
"discount_amount": 0.0,
"item_id": 301,
"name": "Blue mug",
"original_price": 24.5,
"parent_item_id": null,
"price": 24.5,
"product_id": 12,
"product_type": "simple",
"qty_canceled": 0,
"qty_invoiced": 2,
"qty_ordered": 2,
"qty_refunded": 0,
"qty_shipped": 0,
"row_total": 49.0,
"sku": "MUG-BLUE",
"tax_amount": 0.0
}
],
"payment_method": "checkmo",
"shipping_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"shipping_amount": 10.0,
"shipping_description": "Flat Rate - Fixed",
"shipping_method": "flatrate_flatrate",
"state": "processing",
"status": "processing",
"store_id": 1,
"subtotal": 49.0,
"tax_amount": 0.0,
"total_due": 0.0,
"total_paid": 59.0,
"total_qty_ordered": 2,
"total_refunded": 0.0,
"updated_at": "2026-10-20 15:10:42"
}
}Get product
Get one product by its SKU, with its price, stock, status, websites, categories and every other attribute.
Inputs
- SKU
skutextRequired - The product's SKU, exactly as in Magento.
Outputs
productobject- The product
Example output
{
"product": {
"attribute_set_id": 4,
"category_ids": [
3
],
"created_at": "2026-08-01 09:00:00",
"custom_attributes": {
"tax_class_id": "2"
},
"description": "<p>A blue mug.</p>",
"id": 12,
"is_in_stock": true,
"name": "Blue mug",
"price": 24.5,
"quantity": 40,
"short_description": null,
"sku": "MUG-BLUE",
"special_price": null,
"status": "enabled",
"type_id": "simple",
"updated_at": "2026-10-20 12:00:00",
"url_key": "blue-mug",
"visibility": "catalog_search",
"website_ids": [
1
],
"weight": 0.4
}
}Invoice order
Invoice everything on an order not yet invoiced. For an offline payment such as a check, this marks the order paid; for a card payment that was only authorized, turn on Capture payment to charge it.
Inputs
- Order ID
order_idtextRequired - The order's id: 'id' from 'List orders' or 'Get order', or the number after order_id/ in the admin's address for the order. It isn't the order number customers see.
- Capture payment
capturetrue/false - Have the payment gateway charge the customer now. Only for card payments that were authorized but not yet charged; off by default.
- Email the customer
notify_customertrue/false - Send the customer Magento's email about it. Off by default.
- Comment
commenttext - A comment to keep with it, shown in the admin.
Outputs
invoice_idnumber- The new invoice's id
orderobject- The order, now invoiced
Example output
{
"invoice_id": 61,
"order": {
"billing_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"comments": [
{
"comment": "Packed and ready.",
"created_at": "2026-10-20 15:10:42",
"is_customer_notified": false,
"is_visible_on_front": false,
"status": "processing"
}
],
"created_at": "2026-10-20 14:03:11",
"currency": "USD",
"customer_email": "jo@example.com",
"customer_firstname": "Jo",
"customer_group_id": 1,
"customer_id": 45,
"customer_is_guest": false,
"customer_lastname": "Bloggs",
"discount_amount": 0.0,
"grand_total": 59.0,
"id": 123,
"increment_id": "000000123",
"items": [
{
"discount_amount": 0.0,
"item_id": 301,
"name": "Blue mug",
"original_price": 24.5,
"parent_item_id": null,
"price": 24.5,
"product_id": 12,
"product_type": "simple",
"qty_canceled": 0,
"qty_invoiced": 2,
"qty_ordered": 2,
"qty_refunded": 0,
"qty_shipped": 0,
"row_total": 49.0,
"sku": "MUG-BLUE",
"tax_amount": 0.0
}
],
"payment_method": "checkmo",
"shipping_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"shipping_amount": 10.0,
"shipping_description": "Flat Rate - Fixed",
"shipping_method": "flatrate_flatrate",
"state": "processing",
"status": "processing",
"store_id": 1,
"subtotal": 49.0,
"tax_amount": 0.0,
"total_due": 0.0,
"total_paid": 59.0,
"total_qty_ordered": 2,
"total_refunded": 0.0,
"updated_at": "2026-10-20 15:10:42"
}
}List customer groups
List customer groups with their tax classes, optionally only those whose name contains some text.
Inputs
- Name contains
codetext - Only groups whose name contains this text.
- Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page
pagenumber - Which page to return, from 1. Use 'next_page' from an earlier page.At least 1.
Outputs
countnumber- How many are on this page
customer_groupslist- The groups on this page
has_moretrue/false- True when there are more pages after this one
next_pagenumber- The page to ask for next; empty on the last page
pagenumber- This page's number, from 1
page_sizenumber- How many a page holds
total_countnumber- How many match in all, across every page
Example output
{
"count": 1,
"customer_groups": [
{
"code": "Wholesale",
"id": 4,
"tax_class_id": 3,
"tax_class_name": "Retail Customer"
}
],
"has_more": false,
"next_page": null,
"page": 1,
"page_size": 20,
"total_count": 1
}List customers
List customer accounts, oldest first, filtered by email, group or when they were created or last changed. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Email
emailtext - Only the customer with this email address. Use % as a wildcard, such as %@acme.com for everyone at Acme.
- Customer group
group_idtext - Only customers in this group.
- Created from
created_fromdate and time - Only accounts created at or after this time.
- Updated since
updated_sincedate and time - Only those changed at or after this time.
- Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page
pagenumber - Which page to return, from 1. Use 'next_page' from an earlier page.At least 1.
Outputs
countnumber- How many are on this page
customerslist- The customers on this page
has_moretrue/false- True when there are more pages after this one
next_pagenumber- The page to ask for next; empty on the last page
pagenumber- This page's number, from 1
page_sizenumber- How many a page holds
total_countnumber- How many match in all, across every page
Example output
{
"count": 1,
"customers": [
{
"addresses": [
{
"city": "Austin",
"company": "Acme",
"country_id": "US",
"default_billing": true,
"default_shipping": true,
"firstname": "Jo",
"id": 7,
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
}
],
"created_at": "2026-09-01 10:00:00",
"created_in": "Default Store View",
"custom_attributes": {},
"default_billing": 7,
"default_shipping": 7,
"dob": "1990-04-01",
"email": "jo@example.com",
"firstname": "Jo",
"gender": "not_specified",
"group_id": 1,
"id": 45,
"is_subscribed": false,
"lastname": "Bloggs",
"middlename": null,
"prefix": null,
"store_id": 1,
"suffix": null,
"taxvat": null,
"updated_at": "2026-10-20 14:03:11",
"website_id": 1
}
],
"has_more": false,
"next_page": null,
"page": 1,
"page_size": 20,
"total_count": 1
}List orders
List orders, newest first, filtered by status, customer or when they were placed or last changed. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Status
statustext - Only orders with this status code, such as pending, processing, complete, canceled or holded. Separate several with commas.
- Customer email
customer_emailtext - Only orders placed with this email address.
- Customer ID
customer_idtext - Only orders from the customer with this id.
- Placed from
created_fromdate and time - Only orders placed at or after this time.
- Placed until
created_todate and time - Only orders placed at or before this time.
- Updated since
updated_sincedate and time - Only those changed at or after this time.
- Order
sorttext - Newest or oldest first. Defaults to newest.One of:
newest(Newest first (default)),oldest(Oldest first). - Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page
pagenumber - Which page to return, from 1. Use 'next_page' from an earlier page.At least 1.
Outputs
countnumber- How many are on this page
has_moretrue/false- True when there are more pages after this one
next_pagenumber- The page to ask for next; empty on the last page
orderslist- The orders on this page
pagenumber- This page's number, from 1
page_sizenumber- How many a page holds
total_countnumber- How many match in all, across every page
Example output
{
"count": 1,
"has_more": false,
"next_page": null,
"orders": [
{
"billing_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"comments": [
{
"comment": "Packed and ready.",
"created_at": "2026-10-20 15:10:42",
"is_customer_notified": false,
"is_visible_on_front": false,
"status": "processing"
}
],
"created_at": "2026-10-20 14:03:11",
"currency": "USD",
"customer_email": "jo@example.com",
"customer_firstname": "Jo",
"customer_group_id": 1,
"customer_id": 45,
"customer_is_guest": false,
"customer_lastname": "Bloggs",
"discount_amount": 0.0,
"grand_total": 59.0,
"id": 123,
"increment_id": "000000123",
"items": [
{
"discount_amount": 0.0,
"item_id": 301,
"name": "Blue mug",
"original_price": 24.5,
"parent_item_id": null,
"price": 24.5,
"product_id": 12,
"product_type": "simple",
"qty_canceled": 0,
"qty_invoiced": 2,
"qty_ordered": 2,
"qty_refunded": 0,
"qty_shipped": 0,
"row_total": 49.0,
"sku": "MUG-BLUE",
"tax_amount": 0.0
}
],
"payment_method": "checkmo",
"shipping_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"shipping_amount": 10.0,
"shipping_description": "Flat Rate - Fixed",
"shipping_method": "flatrate_flatrate",
"state": "processing",
"status": "processing",
"store_id": 1,
"subtotal": 49.0,
"tax_amount": 0.0,
"total_due": 0.0,
"total_paid": 59.0,
"total_qty_ordered": 2,
"total_refunded": 0.0,
"updated_at": "2026-10-20 15:10:42"
}
],
"page": 1,
"page_size": 20,
"total_count": 1
}List products
List products, oldest first, filtered by name, SKU, type, status or when they last changed. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name contains
nametext - Only products whose name contains this text.
- SKU
skutext - Only the product with this SKU. Use % as a wildcard, such as MUG-% for every SKU starting MUG-.
- Type
type_idtext - Only products of this type.One of:
simple,configurable,virtual,bundle,grouped,downloadable. - Status
statustext - Only enabled, or only disabled, products.One of:
enabled,disabled. - Updated since
updated_sincedate and time - Only those changed at or after this time.
- Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page
pagenumber - Which page to return, from 1. Use 'next_page' from an earlier page.At least 1.
Outputs
countnumber- How many are on this page
has_moretrue/false- True when there are more pages after this one
next_pagenumber- The page to ask for next; empty on the last page
pagenumber- This page's number, from 1
page_sizenumber- How many a page holds
productslist- The products on this page
total_countnumber- How many match in all, across every page
Example output
{
"count": 1,
"has_more": false,
"next_page": null,
"page": 1,
"page_size": 20,
"products": [
{
"attribute_set_id": 4,
"category_ids": [
3
],
"created_at": "2026-08-01 09:00:00",
"custom_attributes": {
"tax_class_id": "2"
},
"description": "<p>A blue mug.</p>",
"id": 12,
"is_in_stock": true,
"name": "Blue mug",
"price": 24.5,
"quantity": 40,
"short_description": null,
"sku": "MUG-BLUE",
"special_price": null,
"status": "enabled",
"type_id": "simple",
"updated_at": "2026-10-20 12:00:00",
"url_key": "blue-mug",
"visibility": "catalog_search",
"website_ids": [
1
],
"weight": 0.4
}
],
"total_count": 1
}Ship order
Ship everything on an order not yet shipped, with a tracking number if you have one. An order invoiced and shipped in full becomes complete.
Inputs
- Order ID
order_idtextRequired - The order's id: 'id' from 'List orders' or 'Get order', or the number after order_id/ in the admin's address for the order. It isn't the order number customers see.
- Tracking number
tracking_numbertext - The parcel's tracking number. Leave empty to ship without one.
- Carrier
carriertext - Who carries it. Custom Value (the default) suits any other carrier; name it in Carrier title.One of:
custom(Custom Value (default)),ups(United Parcel Service),usps(United States Postal Service),fedex(Federal Express),dhl. - Carrier title
carrier_titletext - The carrier's name as the customer sees it, such as Royal Mail. Defaults to the carrier chosen.
- Email the customer
notify_customertrue/false - Send the customer Magento's email about it. Off by default.
- Comment
commenttext - A comment to keep with it, shown in the admin.
Outputs
orderobject- The order, now shipped
shipment_idnumber- The new shipment's id
tracking_numbertext- The tracking number added, if one was given
Example output
{
"order": {
"billing_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"comments": [
{
"comment": "Packed and ready.",
"created_at": "2026-10-20 15:10:42",
"is_customer_notified": false,
"is_visible_on_front": false,
"status": "processing"
}
],
"created_at": "2026-10-20 14:03:11",
"currency": "USD",
"customer_email": "jo@example.com",
"customer_firstname": "Jo",
"customer_group_id": 1,
"customer_id": 45,
"customer_is_guest": false,
"customer_lastname": "Bloggs",
"discount_amount": 0.0,
"grand_total": 59.0,
"id": 123,
"increment_id": "000000123",
"items": [
{
"discount_amount": 0.0,
"item_id": 301,
"name": "Blue mug",
"original_price": 24.5,
"parent_item_id": null,
"price": 24.5,
"product_id": 12,
"product_type": "simple",
"qty_canceled": 0,
"qty_invoiced": 2,
"qty_ordered": 2,
"qty_refunded": 0,
"qty_shipped": 0,
"row_total": 49.0,
"sku": "MUG-BLUE",
"tax_amount": 0.0
}
],
"payment_method": "checkmo",
"shipping_address": {
"city": "Austin",
"company": "Acme",
"country_id": "US",
"email": "jo@example.com",
"firstname": "Jo",
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
},
"shipping_amount": 10.0,
"shipping_description": "Flat Rate - Fixed",
"shipping_method": "flatrate_flatrate",
"state": "complete",
"status": "complete",
"store_id": 1,
"subtotal": 49.0,
"tax_amount": 0.0,
"total_due": 0.0,
"total_paid": 59.0,
"total_qty_ordered": 2,
"total_refunded": 0.0,
"updated_at": "2026-10-20 15:10:42"
},
"shipment_id": 48,
"tracking_number": "1Z999AA10123456784"
}Update customer
Change a customer's email, name, group, date of birth, gender, tax number or newsletter subscription. Only the fields given change; addresses stay as they are.
Inputs
- Customer ID
customer_idtextRequired - The customer's id, from 'List customers' or an earlier step.
- Email
emailtext - A new email address. Leave empty to keep it.
- First name
firstnametext - A new first name. Leave empty to keep it.
- Last name
lastnametext - A new last name. Leave empty to keep it.
- Customer group
group_idtext - Move the customer to this group. Leave empty to keep it.
- Date of birth
dobdate - The customer's date of birth.
- Gender
gendertext - The customer's gender, as the admin records it.One of:
male,female,not_specified(Not Specified). - Tax/VAT number
taxvattext - The customer's tax or VAT number.
- Newsletter
is_subscribedtrue/false - On subscribes the customer to the store's newsletter, off unsubscribes them.
Outputs
customerobject- The customer
Example output
{
"customer": {
"addresses": [
{
"city": "Austin",
"company": "Acme",
"country_id": "US",
"default_billing": true,
"default_shipping": true,
"firstname": "Jo",
"id": 7,
"lastname": "Bloggs",
"postcode": "78701",
"region": "Texas",
"region_code": "TX",
"region_id": 57,
"street": [
"1 Main Street"
],
"telephone": "+1 512 555 0100"
}
],
"created_at": "2026-09-01 10:00:00",
"created_in": "Default Store View",
"custom_attributes": {},
"default_billing": 7,
"default_shipping": 7,
"dob": "1990-04-01",
"email": "jo@example.com",
"firstname": "Jo",
"gender": "not_specified",
"group_id": 4,
"id": 45,
"is_subscribed": false,
"lastname": "Bloggs",
"middlename": null,
"prefix": null,
"store_id": 1,
"suffix": null,
"taxvat": null,
"updated_at": "2026-10-20 14:03:11",
"website_id": 1
}
}Update customer group
Rename a customer group or change its tax class.
Inputs
- Customer group
group_idtextRequired - The customer group. Pick one, or give its id from an earlier step.
- Group name
codetext - A new name, up to 32 characters. Leave empty to keep it.
- Tax class
tax_class_idtext - A new customer tax class. Leave empty to keep it.
Outputs
customer_groupobject- The customer group
Example output
{
"customer_group": {
"code": "Trade",
"id": 4,
"tax_class_id": 3,
"tax_class_name": "Retail Customer"
}
}Update product
Change a product's name, price, stock, status, visibility, websites, categories or descriptions. Only the fields given change; websites and categories given replace the old ones.
Inputs
- SKU
skutextRequired - The product's SKU, exactly as in Magento.
- Name
nametext - A new name. Leave empty to keep it.
- Price
pricenumber - A new price. Leave empty to keep it.At least 0.
- Status
statustext - Enabled products can be bought. New products are enabled.One of:
enabled,disabled. - Visibility
visibilitytext - Where shoppers find it: in the catalog, in search, both, or neither (for a product sold only as part of another). New products show in both.One of:
catalog_search(Catalog, Search),catalog,search,not_visible(Not Visible Individually). - Weight
weightnumber - The weight, in the store's weight unit. Not for virtual products.At least 0.
- Quantity
quantitynumber - How many are in stock. It is in stock when above 0. New products start at 0, so give one to make it buyable.At least 0.
- Websites
website_idslist - Which websites sell it. A new product is sold on all of them unless you choose.
- Categories
category_idslist - Which categories to file it under. Pick from the store's, or type ids.
- Description
descriptiontext - The product page's description. HTML is allowed.
- Short description
short_descriptiontext - The short description shown near the price. HTML is allowed.
- URL key
url_keytext - The product page's address within the store, such as blue-mug. Magento makes one from the name when it's empty.
Outputs
productobject- The product
Example output
{
"product": {
"attribute_set_id": 4,
"category_ids": [
3
],
"created_at": "2026-08-01 09:00:00",
"custom_attributes": {
"tax_class_id": "2"
},
"description": "<p>A blue mug.</p>",
"id": 12,
"is_in_stock": true,
"name": "Blue mug",
"price": 22.0,
"quantity": 40,
"short_description": null,
"sku": "MUG-BLUE",
"special_price": null,
"status": "enabled",
"type_id": "simple",
"updated_at": "2026-10-20 12:00:00",
"url_key": "blue-mug",
"visibility": "catalog_search",
"website_ids": [
1
],
"weight": 0.4
}
}