Integrations
Magento
23 actions for Magento.
Read from Magento 2 API#
Execute an ACL-authorized GET operation on the connected Magento store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2ApiGet
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| API Path | Text | Yes | (empty) | Concrete path returned by discovery, beginning with V1/, async/V1/, or async/bulk/V1/, with placeholders replaced. |
| Query Parameters | Object | No | — | Optional query parameters, including Magento searchCriteria keys. |
| Store Code | Text | No | default | Magento store-view code for this request. |
Outputs#
| Output | Type |
|---|---|
| Path | Text |
| Store Code | Text |
| Data | Any |
Use as an agent tool#
Tool name: magento2_api_get
Execute a read-only Magento REST operation; use discovery first for valid paths
Mutate Magento 2 API#
Execute an ACL-authorized POST, PUT, or DELETE operation.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2ApiMutation
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| HTTP Method | Text | No | POST | Mutating HTTP method to execute. Options: POST, PUT, DELETE |
| API Path | Text | Yes | (empty) | Concrete path returned by discovery, beginning with V1/, async/V1/, or async/bulk/V1/, with placeholders replaced. |
| JSON Body | Object | No | — | Request object, or an array of request objects for a bulk operation. |
| Query Parameters | Object | No | — | Optional query parameters for the mutation. |
| Store Code | Text | No | default | Magento store-view code for this request. |
Outputs#
| Output | Type |
|---|---|
| Method | Text |
| Path | Text |
| Store Code | Text |
| Data | Any |
Use as an agent tool#
Tool name: magento2_api_mutation
Execute a Magento REST mutation after human approval; use discovery first for valid paths
Create Customer in Magento 2#
Creates a new customer in Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2CreateCustomer
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Text | Yes | (empty) | Customer email address (required). | |
| First Name | Text | Yes | (empty) | Customer first name (required). |
| Last Name | Text | Yes | (empty) | Customer last name (required). |
| Additional Data | Object | No | — | Additional customer data as JSON object. |
Outputs#
| Output | Type |
|---|---|
| Customer Id | Number |
| Customer Data | Object |
Use as an agent tool#
Tool name: magento2_create_customer
Create a new customer in Magento 2 store
Create Product in Magento 2#
Creates a new product in Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2CreateProduct
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| SKU | Text | Yes | (empty) | Unique product SKU (required). |
| Name | Text | Yes | (empty) | Product name (required). |
| Price | Text | Yes | (empty) | Product price (required). |
| Product Data | Object | No | — | Additional product data as JSON object. |
Outputs#
| Output | Type |
|---|---|
| Sku | Text |
| Product Data | Object |
Use as an agent tool#
Tool name: magento2_create_product
Create a new product in Magento 2 store
Delete Product from Magento 2#
Deletes a product from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2DeleteProduct
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Product SKU | Text | Yes | (empty) | The SKU of the product to delete. |
Outputs#
| Output | Type |
|---|---|
| Sku | Text |
| Success | Yes/No |
| Response Data | Object |
Use as an agent tool#
Tool name: magento2_delete_product
Delete a product from Magento 2 store
Discover Magento 2 API Operations#
Search the connected store’s installed and ACL-visible REST API operations.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2DiscoverApiOperations
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Search | Text | No | (empty) | Optional text matched against paths, services, operation IDs, and summaries. |
| HTTP Method | Text | No | ANY | Optionally restrict discovery to one HTTP method. Options: ANY, GET, POST, PUT, DELETE |
| Service | Text | No | (empty) | Optional Magento service name, for example catalogProductRepositoryV1. |
| API Mode | Text | No | sync | Discover synchronous, asynchronous, or bulk REST operations. Options: sync, async, bulk |
| Result Limit | Number | No | 50 | Maximum number of compact operation summaries to return. |
| Store Code | Text | No | default | Magento store-view code used for schema discovery. |
Outputs#
| Output | Type |
|---|---|
| Operations | List |
| Count | Number |
Use as an agent tool#
Tool name: magento2_discover_api_operations
Discover Magento REST operations available on this installation before calling the generic read or mutation tool
Get Categories from Magento 2#
Gets category tree from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetCategories
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Category ID | Number | No | 0 | Optional category ID. Leave 0 for root tree. |
Outputs#
| Output | Type |
|---|---|
| Categories | Object |
Use as an agent tool#
Tool name: magento2_get_categories
Get category tree from Magento 2 store
Get Credit Memos from Magento 2#
Gets credit memos from Magento 2 store with pagination and filters.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetCreditMemos
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Order ID | Text | No | (empty) | Optional order ID to filter credit memos. |
| From Date | Text | No | (empty) | Start date for credit memos (YYYY-MM-DD format). |
| To Date | Text | No | (empty) | End date for credit memos (YYYY-MM-DD format). |
| Page Size | Number | No | 20 | Number of credit memos per page (default: 20). |
| Current Page | Number | No | 1 | Page number (default: 1). |
Outputs#
| Output | Type |
|---|---|
| Items | List |
| Total Count | Number |
Use as an agent tool#
Tool name: magento2_get_credit_memos
Get credit memos from Magento 2 store
Get Customer from Magento 2#
Gets a single customer by ID from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetCustomer
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Customer ID | Number | Yes | 0 | The ID of the customer to retrieve. |
Outputs#
| Output | Type |
|---|---|
| Customer Id | Number |
| Customer Data | Object |
Use as an agent tool#
Tool name: magento2_get_customer
Get a single customer by ID from Magento 2 store
Get Customers from Magento 2#
Gets customers from Magento 2 store with pagination and filters.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetCustomers
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Filter Groups | Object | No | — | Search filter groups as JSON array. |
| Page Size | Number | No | 20 | Number of customers per page (default: 20). |
| Current Page | Number | No | 1 | Page number (default: 1). |
Outputs#
| Output | Type |
|---|---|
| Customers | List |
| Total Count | Number |
Use as an agent tool#
Tool name: magento2_get_customers
Get customers from Magento 2 store
Get Inventory from Magento 2#
Gets inventory/stock information for a product from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetInventory
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Product SKU | Text | Yes | (empty) | The SKU of the product to get inventory for. |
Outputs#
| Output | Type |
|---|---|
| Sku | Text |
| Inventory Data | Object |
Use as an agent tool#
Tool name: magento2_get_inventory
Get inventory/stock information for a product from Magento 2 store
Get Order from Magento 2#
Gets a single order from a Magento 2 store by order number, returning it only when it belongs to the given customer email.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetOrder
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Customer Email | Text | Yes | (empty) | Email address the order was placed under. Ask the customer for it; the order is only returned when it belongs to this email. |
| Order Number | Text | Yes | (empty) | Customer-facing order number as it appears on the confirmation email or invoice (e.g. “000000123”). |
Outputs#
| Output | Type |
|---|---|
| Found | Yes/No |
| Increment Id | Text |
| Customer Email | Text |
| Order Id | Number |
| Order Data | Object |
Use as an agent tool#
Tool name: magento2_get_order
Get the status and details of one Magento 2 order. Requires BOTH the customer’s email address and the order number (increment ID); ask the customer for whichever one is missing instead of guessing. Returns the order only when that order number belongs to that email.
Get Order Count from Magento 2#
Gets the number of orders from Magento 2 store with optional filters.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetOrderCount
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| From Date | Text | No | (empty) | Start date for orders (YYYY-MM-DD format). |
| To Date | Text | No | (empty) | End date for orders (YYYY-MM-DD format). |
| Order Status | Text | No | (empty) | Optional order status to filter by. |
Outputs#
| Output | Type |
|---|---|
| Order Count | Number |
Use as an agent tool#
Tool name: magento2_get_order_count
Get the number of Magento 2 orders for a date range or status
Get Orders from Magento 2#
Gets orders from Magento 2 store with pagination and filters.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetOrders
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Filter Groups | Object | No | — | Search filter groups as JSON array. |
| Page Size | Number | No | 20 | Number of orders per page (default: 20). |
| Current Page | Number | No | 1 | Page number (default: 1). |
Outputs#
| Output | Type |
|---|---|
| Orders | List |
| Total Count | Number |
Use as an agent tool#
Tool name: magento2_get_orders
Get orders from Magento 2 store
Get Product from Magento 2#
Gets a single product by SKU from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetProduct
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Product SKU | Text | Yes | (empty) | The SKU of the product to retrieve. |
Outputs#
| Output | Type |
|---|---|
| Sku | Text |
| Product Data | Object |
Use as an agent tool#
Tool name: magento2_get_product
Get a single product by SKU from Magento 2 store
Get Product Sales from Magento 2#
Gets product sales statistics from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetProductSales
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Product SKU | Text | Yes | (empty) | The SKU of the product to get sales for. |
| From Date | Text | No | (empty) | Start date for sales (YYYY-MM-DD format). |
| To Date | Text | No | (empty) | End date for sales (YYYY-MM-DD format). |
Outputs#
| Output | Type |
|---|---|
| Sku | Text |
| Total Quantity Sold | Number |
| Total Revenue | Number |
| Order Count | Number |
| Average Quantity Per Order | Number |
Use as an agent tool#
Tool name: magento2_get_product_sales
Get quantity sold, revenue, and order count for a Magento 2 product
Get Products from Magento 2#
Gets products from Magento 2 store with pagination and filters.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetProducts
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Filter Groups | Object | No | — | Search filter groups as JSON array. |
| Page Size | Number | No | 20 | Number of products per page (default: 20). |
| Current Page | Number | No | 1 | Page number (default: 1). |
Outputs#
| Output | Type |
|---|---|
| Products | List |
| Total Count | Number |
Use as an agent tool#
Tool name: magento2_get_products
Get products from Magento 2 store
Get Store Analytics from Magento 2#
Gets store analytics including revenue and order statistics from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetStoreAnalytics
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| From Date | Text | No | (empty) | Start date for analytics (YYYY-MM-DD format). |
| To Date | Text | No | (empty) | End date for analytics (YYYY-MM-DD format). |
| Country | Text | No | (empty) | Optional country code to filter analytics (e.g., US, GB). |
Outputs#
| Output | Type |
|---|---|
| Total Revenue | Number |
| Order Count | Number |
| Average Order Value | Number |
| Analytics Data | Object |
Use as an agent tool#
Tool name: magento2_get_store_analytics
Get store analytics including revenue and order statistics from Magento 2 store
Get Store Configs from Magento 2#
Gets store views, base currencies, and base URLs from Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2GetStoreConfigs
Outputs#
| Output | Type |
|---|---|
| Configs | List |
Use as an agent tool#
Tool name: magento2_get_store_configs
Get store views and the currency each Magento 2 store prices in
Update Customer in Magento 2#
Updates an existing customer in Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2UpdateCustomer
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Customer ID | Number | Yes | 0 | The ID of the customer to update (required). |
| Text | No | (empty) | Updated email address. | |
| First Name | Text | No | (empty) | Updated first name. |
| Last Name | Text | No | (empty) | Updated last name. |
| Additional Data | Object | No | — | Additional customer data to update as JSON object. |
Outputs#
| Output | Type |
|---|---|
| Customer Id | Number |
| Success | Yes/No |
| Customer Data | Object |
Use as an agent tool#
Tool name: magento2_update_customer
Update an existing customer in Magento 2 store
Update Inventory in Magento 2#
Updates inventory/stock information for a product in Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2UpdateInventory
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Product SKU | Text | Yes | (empty) | The SKU of the product to update inventory for. |
| Quantity | Number | Yes | 0 | New stock quantity. |
| Is In Stock | Number | No | 1 | Whether the product is in stock (1 = yes, 0 = no). |
Outputs#
| Output | Type |
|---|---|
| Sku | Text |
| Success | Yes/No |
| Inventory Data | Object |
Use as an agent tool#
Tool name: magento2_update_inventory
Update inventory/stock information for a product in Magento 2 store
Update Order Status in Magento 2#
Updates the status of an order in Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2UpdateOrderStatus
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| Order ID | Number | Yes | 0 | The ID of the order to update. |
| Status | Text | Yes | (empty) | New order status (e.g., processing, complete, canceled). |
| Comment | Text | No | (empty) | Optional comment for the status change. |
Outputs#
| Output | Type |
|---|---|
| Order Id | Number |
| Success | Yes/No |
| Response Data | Object |
Use as an agent tool#
Tool name: magento2_update_order_status
Update the status of an order in Magento 2 store
Update Product in Magento 2#
Updates an existing product in Magento 2 store.
Plans: Trial, Pro, Premium, Enterprise · Type: Magento2UpdateProduct
Inputs#
| Field | Type | Required | Default | What it does |
|---|---|---|---|---|
| SKU | Text | Yes | (empty) | The SKU of the product to update (required). |
| Name | Text | No | (empty) | Updated product name. |
| Price | Text | No | (empty) | Updated product price. |
| Product Data | Object | No | — | Additional product data to update as JSON object. |
Outputs#
| Output | Type |
|---|---|
| Sku | Text |
| Success | Yes/No |
| Product Data | Object |
Use as an agent tool#
Tool name: magento2_update_product
Update an existing product in Magento 2 store