PlugsightDocs

Magento tools

Every Magento / Adobe Commerce tool in the developer API, with arguments and examples: sales, orders, products and customers.

Needs: A Magento store. 5 tools.

These tools appear in GET /v1/tools only when the API key's MCP server includes a connection of this kind. Call each one with POST /v1/tools/\<name>, sending its arguments as a JSON object. See Calling tools for the request and response format.

Tool What it does Kind
magento_sales_report Magento sales Read
magento_list_orders List Magento orders Read
magento_get_order Read a Magento order Read
magento_search_products Search Magento products Read
magento_search_customers Search Magento customers Read

The example requests fill in only the required arguments, with placeholder values.

magento_sales_report

Magento sales · Read

Sales for a period from a Magento / Adobe Commerce store, added up from its orders: revenue, orders, items, average order, discounts, shipping, tax and refunds, a per-day breakdown and the best-selling products. Cancelled orders are left out. Dates are UTC.

Argument Type Required What it is
from string Yes YYYY-MM-DD (UTC)
to string Yes YYYY-MM-DD (UTC)
top_products integer No How many best-selling products to list. Default 10.
account string No Store connection id from list_accounts (optional when there's only one)

Example request:

curl -X POST https://app.plugsight.app/v1/tools/magento_sales_report \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from": "2026-11-01", "to": "2026-11-15"}'

magento_list_orders

List Magento orders · Read

Orders, newest first, optionally by status, date range (UTC) or customer email. Use magento_get_order for the items, addresses, payment and comments of one order.

Argument Type Required What it is
status string No e.g. pending, processing, complete, canceled, closed, holded
from string No YYYY-MM-DD (UTC)
to string No YYYY-MM-DD (UTC)
email string No Customer email, or part of it
limit integer No Most results to return. Default 25.
page integer No Page of results, from 1. Default 1.
account string No Store connection id from list_accounts (optional when there's only one)

Example request:

curl -X POST https://app.plugsight.app/v1/tools/magento_list_orders \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

magento_get_order

Read a Magento order · Read

One order in full by its order number (e.g. 000000123) or id: items, totals, discounts, shipping, refunds, payment method, addresses and comments.

Argument Type Required What it is
order string Yes Order number as customers see it, or the id from magento_list_orders
account string No Store connection id from list_accounts (optional when there's only one)

Example request:

curl -X POST https://app.plugsight.app/v1/tools/magento_get_order \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"order": "…"}'

magento_search_products

Search Magento products · Read

Products by name or SKU with price, type and status. Set low_stock_below to list products whose stock is at or under that quantity instead.

Argument Type Required What it is
search string No Part of the product name
sku string No SKU, or part of it
low_stock_below integer No Only products with less stock than this
limit integer No Most results to return. Default 25.
page integer No Page of results, from 1. Default 1.
account string No Store connection id from list_accounts (optional when there's only one)

Example request:

curl -X POST https://app.plugsight.app/v1/tools/magento_search_products \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

magento_search_customers

Search Magento customers · Read

Registered customers by email or name, with when they joined and their default address. Use magento_list_orders with email for their orders.

Argument Type Required What it is
email string No Email, or part of it
name string No First or last name, or part of it
limit integer No Most results to return. Default 25.
page integer No Page of results, from 1. Default 1.
account string No Store connection id from list_accounts (optional when there's only one)

Example request:

curl -X POST https://app.plugsight.app/v1/tools/magento_search_customers \
  -H "Authorization: Bearer $PLUGSIGHT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'