Shift4Shop MCP by usefulapi

Read orders, payments, shipments, customers, products and stock in Shift4Shop.

Should I use this

Quality & Safety

A
Description quality
100%
Schema completeness
91%
Naming quality
77%
Poisoning risk
100%
Permission match
100%
Protocol compliance
100%

Findings (2)

  • LOWTool 'shift4shop_list_order_shipments' name length outside 3-30 rangein shift4shop_list_order_shipments
  • LOWTool 'shift4shop_list_order_transactions' name length outside 3-30 rangein shift4shop_list_order_transactions

Based on automated analysis of tool definitions and protocol compliance.

Context Cost

~2,701Tokens (tool definitions)
~1.7 KBTypical response size
Significant attention impact (2.11% of 128k context)

This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.

Install

One-Click Install

Add this to your `claude_desktop_config.json` file:

{
  "mcpServers": {
    "shift4shop": {
      "url": "https://shift4shop.usefulapi.io/mcp"
    }
  }
}

Remote endpoints

https://shift4shop.usefulapi.io/mcpstreamable-http

What it can do

Tool inventory

Tools (13)

🟢 Read-only🟡 Write🔴 Delete⚪ Unknown
🟢shift4shop_list_orders(invoicenumber, invoicenumberstart, invoicenumberend, invoiceprefix, orderstatus, ...)

List store orders, filterable by status, order (invoice) number, date range, last-update range or billing email. Use this first to find orders. Shift4Shop API: GET /Orders.

Input Schema

{
  "type": "object",
  "properties": {
    "invoicenumber": {
      "description": "Exact invoice (order) number.",
      "type": "string"
    },
    "invoicenumberstart": {
      "description": "First invoice number of a range.",
      "type": "string"
    },
    "invoicenumberend": {
      "description": "Last invoice number of a range.",
      "type": "string"
    },
    "invoiceprefix": {
      "description": "Only orders whose invoice number has this prefix.",
      "type": "string"
    },
    "orderstatus": {
      "description": "Only orders in this status (see shift4shop_list_order_statuses).",
      "type": "string"
    },
    "datestart": {
      "description": "Orders placed after this time (mm/dd/yyyy hh:mm:ss).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}( \\d{2}:\\d{2}:\\d{2})?$"
    },
    "dateend": {
      "description": "Orders placed before this time (mm/dd/yyyy hh:mm:ss).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}( \\d{2}:\\d{2}:\\d{2})?$"
    },
    "lastupdatestart": {
      "description": "Orders last updated after this date (mm/dd/yyyy).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$"
    },
    "lastupdateend": {
      "description": "Orders last updated before this date (mm/dd/yyyy).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}$"
    },
    "billingemail": {
      "description": "Billing email address of the order.",
      "type": "string"
    },
    "limit": {
      "description": "Maximum number of items to return.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "countonly": {
      "description": "Return only the number of matching rows.",
      "type": "boolean"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_get_order(orderid)

Get one order by its id (the invoice number), with customer, totals and status. Shift4Shop API: GET /Orders/{orderid}.

Input Schema

{
  "type": "object",
  "properties": {
    "orderid": {
      "type": "string",
      "minLength": 1,
      "description": "The order id (invoice number), for example from shift4shop_list_orders."
    }
  },
  "required": [
    "orderid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_list_order_items(orderid, limit, offset)

List the line items of one order (products, quantities, prices). Shift4Shop API: GET /Orders/{orderid}/Items.

Input Schema

{
  "type": "object",
  "properties": {
    "orderid": {
      "type": "string",
      "minLength": 1,
      "description": "The order id (invoice number)."
    },
    "limit": {
      "description": "Maximum number of items to return.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "orderid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_list_order_shipments(orderid, limit, offset)

List the shipments recorded for one order, including tracking data. Shift4Shop API: GET /Orders/{orderid}/Shipments.

Input Schema

{
  "type": "object",
  "properties": {
    "orderid": {
      "type": "string",
      "minLength": 1,
      "description": "The order id (invoice number)."
    },
    "limit": {
      "description": "Maximum number of items to return.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "orderid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_list_order_transactions(orderid, limit, offset)

List the payment transactions recorded for one order. Shift4Shop API: GET /Orders/{orderid}/Transactions.

Input Schema

{
  "type": "object",
  "properties": {
    "orderid": {
      "type": "string",
      "minLength": 1,
      "description": "The order id (invoice number)."
    },
    "limit": {
      "description": "Maximum number of items to return.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "orderid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_list_order_statuses(limit, offset, countonly)

List the order statuses configured in the store (use their ids or names in shift4shop_list_orders). Shift4Shop API: GET /OrderStatus.

Input Schema

{
  "type": "object",
  "properties": {
    "limit": {
      "description": "Maximum number of items to return.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "countonly": {
      "description": "Return only the number of matching rows.",
      "type": "boolean"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_list_customers(email, firstname, lastname, country, state, ...)

List store customers, filterable by email, name, country, state, city, phone or last-update range. Shift4Shop API: GET /Customers.

Input Schema

{
  "type": "object",
  "properties": {
    "email": {
      "description": "Customer email address.",
      "type": "string"
    },
    "firstname": {
      "description": "Customer first name.",
      "type": "string"
    },
    "lastname": {
      "description": "Customer last name.",
      "type": "string"
    },
    "country": {
      "description": "Country name.",
      "type": "string"
    },
    "state": {
      "description": "State or region.",
      "type": "string"
    },
    "city": {
      "description": "City.",
      "type": "string"
    },
    "phone": {
      "description": "Phone number.",
      "type": "string"
    },
    "lastupdatestart": {
      "description": "Customers last updated after this time (mm/dd/yyyy hh:mm:ss).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}( \\d{2}:\\d{2}:\\d{2})?$"
    },
    "lastupdateend": {
      "description": "Customers last updated before this time (mm/dd/yyyy hh:mm:ss).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}( \\d{2}:\\d{2}:\\d{2})?$"
    },
    "limit": {
      "description": "Maximum number of items to return.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "countonly": {
      "description": "Return only the number of matching rows.",
      "type": "boolean"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_get_customer(id)

Get one customer by id, with contact and billing details. Shift4Shop API: GET /Customers/{id}.

Input Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The customer id, for example from shift4shop_list_customers."
    }
  },
  "required": [
    "id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_list_products(sku, name, costfrom, costto, pricefrom, ...)

List catalog products, filterable by SKU, name, cost or price range, stock range and flags (hidden, on sale, not for sale). Shift4Shop API: GET /Products.

Input Schema

{
  "type": "object",
  "properties": {
    "sku": {
      "description": "Product SKU.",
      "type": "string"
    },
    "name": {
      "description": "Product name.",
      "type": "string"
    },
    "costfrom": {
      "description": "Cost greater than this.",
      "type": "number"
    },
    "costto": {
      "description": "Cost less than this.",
      "type": "number"
    },
    "pricefrom": {
      "description": "Price greater than this.",
      "type": "number"
    },
    "priceto": {
      "description": "Price less than this.",
      "type": "number"
    },
    "stockfrom": {
      "description": "Stock greater than this.",
      "type": "number"
    },
    "stockto": {
      "description": "Stock less than this.",
      "type": "number"
    },
    "hide": {
      "description": "Only hidden products.",
      "type": "boolean"
    },
    "onsale": {
      "description": "Only products on sale.",
      "type": "boolean"
    },
    "notforsale": {
      "description": "Only products set as not for sale.",
      "type": "boolean"
    },
    "lastupdatestart": {
      "description": "Products last updated after this time (mm/dd/yyyy hh:mm:ss).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}( \\d{2}:\\d{2}:\\d{2})?$"
    },
    "lastupdateend": {
      "description": "Products last updated before this time (mm/dd/yyyy hh:mm:ss).",
      "type": "string",
      "pattern": "^\\d{2}\\/\\d{2}\\/\\d{4}( \\d{2}:\\d{2}:\\d{2})?$"
    },
    "limit": {
      "description": "Maximum number of items to return.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "countonly": {
      "description": "Return only the number of matching rows.",
      "type": "boolean"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_get_product(catalogid)

Get one product by its catalog id, with price, stock and description. Shift4Shop API: GET /Products/{catalogid}.

Input Schema

{
  "type": "object",
  "properties": {
    "catalogid": {
      "type": "string",
      "minLength": 1,
      "description": "The product catalog id, for example from shift4shop_list_products."
    }
  },
  "required": [
    "catalogid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_list_categories(category, limit, offset, countonly)

List the store's product categories. Shift4Shop API: GET /Categories.

Input Schema

{
  "type": "object",
  "properties": {
    "category": {
      "description": "Find a category by its name.",
      "type": "string"
    },
    "limit": {
      "description": "Maximum number of categories (max 500).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 500
    },
    "offset": {
      "description": "Starting point for the returned items (0 = first).",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "countonly": {
      "description": "Return only the number of matching rows.",
      "type": "boolean"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_get_category(categoryid)

Get one product category by id. Shift4Shop API: GET /Categories/{categoryid}.

Input Schema

{
  "type": "object",
  "properties": {
    "categoryid": {
      "type": "string",
      "minLength": 1,
      "description": "The category id, for example from shift4shop_list_categories."
    }
  },
  "required": [
    "categoryid"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢shift4shop_get_store_settings

Get the store's general settings (store name, currency and other configuration). Shift4Shop API: GET /StoreSettings.

Input Schema

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Community

Rate this Server

Evidence

Recent observations

verifiedversion not recorded13 tools