PlugsightDocs

Shopify tools

Every Shopify tool in the developer API, with arguments and examples: sales, orders, products, stock and customers.

Updated

Needs: A Shopify store. 6 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
shopify_sales_report Shopify sales Read
shopify_list_orders List Shopify orders Read
shopify_get_order Read a Shopify order Read
shopify_search_products Search Shopify products Read
shopify_inventory Shopify stock by location Read
shopify_search_customers Search Shopify customers Read

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

shopify_sales_report

Shopify sales · Read

Sales for a period from a Shopify store, added up from every order in it: revenue (order totals), orders, items, average order, discounts, shipping, tax and refunds, a per-day breakdown and the best-selling products. Only paid orders count (paid, partially paid, partially refunded, refunded); pending, authorised-only, voided and expired payments, cancelled orders and test orders are listed separately under excluded. Amounts are in the store's currency. On very busy stores or long periods the report can stop early: then complete is false and covered_through says how far it got. complete is also false when the period starts more than 60 days ago and the store's app lacks read_all_orders; note says why. Dates are UTC. Pass account to choose the store when several are connected.

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 store)

Example request:

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

shopify_list_orders

List Shopify orders · Read

Orders, newest first, optionally by status, payment status, fulfilment status, date range (UTC), customer email or free text. Use shopify_get_order for the items, addresses, shipping, tracking and refunds of one order.

Argument Type Required What it is
status string No Order status: open, closed (archived), cancelled, or any. One of: open, closed, cancelled, any. Default "any".
payment string No Payment (financial) status. One of: paid, pending, authorized, partially_paid, partially_refunded, refunded, voided, expired.
fulfilment string No Fulfilment status: shipped, partial, unshipped (none shipped), unfulfilled (not fully shipped), on_hold or scheduled. One of: shipped, partial, unshipped, unfulfilled, on_hold, scheduled.
from string No YYYY-MM-DD (UTC)
to string No YYYY-MM-DD (UTC)
email string No Customer email
search string No Free text: an order number, customer name, product title or SKU
limit integer No Most results to return. Default 25.
cursor string No next_cursor from the previous page, for the page after it
account string No Store connection id from list_accounts (optional when there's only one store)

Example request:

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

shopify_get_order

Read a Shopify order · Read

One order in full by its order number (e.g. #1001) or id: items with variant, SKU, quantities still to ship and refunded, totals, discount codes, shipping method, tax, payment gateways, addresses, note and tags, its fulfilments with tracking numbers, and its refunds.

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

Example request:

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

shopify_search_products

Search Shopify products · Read

Products by title, SKU, vendor or type, with status, price range, total stock and their variants (price, compare-at price, SKU, stock). Set low_stock_below to list variants whose stock is at or under that quantity instead, lowest first.

Argument Type Required What it is
search string No Words in the product title, or other free text
sku string No A variant's SKU
vendor string No The product vendor (brand or supplier), as set on the product
product_type string No The product type, as set on the product
status string No Status. One of: active, draft, archived.
low_stock_below integer No List variants with this many or fewer in stock (tracked inventory only)
limit integer No Most results to return. Default 25.
cursor string No next_cursor from the previous page, for the page after it
account string No Store connection id from list_accounts (optional when there's only one store)

Example request:

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

shopify_inventory

Shopify stock by location · Read

Stock of one product's variants at each location: available, on hand, committed (ordered, not yet shipped) and incoming. Find the product by SKU or by its id from shopify_search_products.

Argument Type Required What it is
sku string No A variant's SKU
product_id string No Product id from shopify_search_products
account string No Store connection id from list_accounts (optional when there's only one store)

Example request:

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

shopify_search_customers

Search Shopify customers · Read

Customers by name, email or other text, with their order count, amount spent, when they joined, tags and location. Use shopify_list_orders with email for their orders.

Argument Type Required What it is
search string No Name, email, phone or other text
email string No Exact email address
limit integer No Most results to return. Default 25.
cursor string No next_cursor from the previous page, for the page after it
account string No Store connection id from list_accounts (optional when there's only one store)

Example request:

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