Orders

This reference is auto-generated from the registered MCP tool providers in perspectapiworkers. It reflects the tools exposed by the per-site Perspect MCP server.

Connection

Use the per-site MCP endpoint:

https://perspect.com/mcp/{siteName}

Authenticate with OAuth or an MCP API key using Authorization: Bearer sk_mcp_....

Tools

order_list

Title: List Orders

List orders for a site (alias for transactions)

Required permission: orders.read

Parameters

Parameter	Type	Required	Default	Description
limit	number	No	20	Maximum number of results
offset	number	No	0	Number of results to skip
fulfillment_status	string	No	—	Filter by fulfillment status Allowed: unfulfilled, partial, fulfilled, cancelled.

Example call

{
  "tool": "order_list",
  "arguments": {
    "limit": 20,
    "offset": 0
  }
}

Output schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        },
        "total": {
          "type": "number"
        }
      },
      "required": [
        "limit",
        "offset",
        "total"
      ]
    }
  },
  "required": [
    "success",
    "data",
    "metadata"
  ]
}

transaction_get

Title: Get Transaction

Get details for a specific transaction

Required permission: orders.read

Parameters

Parameter	Type	Required	Default	Description
transactionId	string	Yes	—	Transaction ID

Example call

{
  "tool": "transaction_get",
  "arguments": {
    "transactionId": "string"
  }
}

Output schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "additionalProperties": true
    }
  },
  "required": [
    "success",
    "data"
  ]
}

transaction_items

Title: List Transaction Items

Get line items for a transaction

Required permission: orders.read

Parameters

Parameter	Type	Required	Default	Description
transactionId	string	Yes	—	Transaction ID

Example call

{
  "tool": "transaction_items",
  "arguments": {
    "transactionId": "string"
  }
}

Output schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "transactionId": {
          "type": "string"
        },
        "totalItems": {
          "type": "number"
        }
      },
      "required": [
        "transactionId",
        "totalItems"
      ]
    }
  },
  "required": [
    "success",
    "data",
    "metadata"
  ]
}

transaction_list

Title: List Transactions

List transactions for a site with optional filters

Required permission: orders.read

Parameters

Parameter	Type	Required	Default	Description
limit	number	No	20	Maximum number of results (1-100)
offset	number	No	0	Number of results to skip
status	string	No	—	Filter by transaction status Allowed: pending, processing, completed, failed, cancelled, refunded.
customer_email	string	No	—	Filter by customer email
date_from	string	No	—	Filter transactions from this date (ISO 8601)
date_to	string	No	—	Filter transactions until this date (ISO 8601)

Example call

{
  "tool": "transaction_list",
  "arguments": {
    "limit": 20,
    "offset": 0
  }
}

Output schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "metadata": {
      "type": "object",
      "properties": {
        "limit": {
          "type": "number"
        },
        "offset": {
          "type": "number"
        },
        "total": {
          "type": "number"
        }
      },
      "required": [
        "limit",
        "offset",
        "total"
      ]
    }
  },
  "required": [
    "success",
    "data",
    "metadata"
  ]
}

transaction_refund

Title: Refund Transaction

Process a refund for a transaction. Omit amount for a full refund, or specify a partial amount. Use transaction_get first to verify the transaction details and current status. Valid from: completed.

Required permission: orders.update

Parameters

Parameter	Type	Required	Default	Description
transactionId	string	Yes	—	Transaction ID
amount	number	No	—	Refund amount (partial refunds allowed)
reason	string	No	—	Reason for refund

Example call

{
  "tool": "transaction_refund",
  "arguments": {
    "transactionId": "string"
  }
}

Output schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "success",
    "message"
  ]
}

transaction_stats

Title: Transaction Stats

Get transaction statistics for a site

Required permission: orders.read

Parameters

Parameter	Type	Required	Default	Description
period	string	No	"month"	Time period for statistics Allowed: day, week, month, year, all.
date_from	string	No	—	Start date for custom period (ISO 8601)
date_to	string	No	—	End date for custom period (ISO 8601)

Example call

{
  "tool": "transaction_stats",
  "arguments": {
    "period": "month"
  }
}

Output schema

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "data": {
      "type": "object",
      "properties": {
        "period": {
          "type": "object",
          "properties": {
            "start": {
              "type": "string"
            },
            "end": {
              "type": "string"
            }
          },
          "required": [
            "start",
            "end"
          ]
        },
        "stats": {
          "type": "object",
          "additionalProperties": true
        },
        "topProducts": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": true
          }
        }
      },
      "required": [
        "period",
        "stats",
        "topProducts"
      ]
    }
  },
  "required": [
    "success",
    "data"
  ]
}

---

This page is generated from the registered MCP tool providers. Do not edit it by hand.