Skip to main content
Glama

ebay_get_payouts

Read-only

List seller payouts from eBay Finances within the last five years, filter by payout date or status, then page and sort results for reconciliation.

Instructions

List seller payouts from the eBay Finances API (last five years). Filter by payoutDate range and/or payoutStatus, page with limit/offset, sort by payoutDate. Returns a success status with no data when nothing matches. Requires the sell.finances scope. eBay requires Digital Signatures on Finances API calls for EU/UK sellers; set EBAY_SIGNING_KEY_JWE and EBAY_SIGNING_PRIVATE_KEY to sign them.

Input Schema

NameRequiredDescriptionDefault
sortNoSet to payoutDate (or lastAttemptedPayoutDate for retryable failures) for oldest first. eBay sorts newest first by default.
limitNoRecords per page, up to 200 (eBay default 20)
filterNoPayout filter. Criteria: payoutDate:[2024-12-17T00:00:01.000Z..2024-12-24T00:00:01.000Z] (within the last five years, range up to 36 months); payoutStatus:{SUCCEEDED} (one PayoutStatusEnum value, e.g. INITIATED, SUCCEEDED, RETRYABLE_FAILED, TERMINAL_FAILED, REVERSED); lastAttemptedPayoutDate:[start..end] (requires payoutStatus:{RETRYABLE_FAILED}); payoutReference:{5********3} (mainland China sellers only). Separate multiple criteria with commas. eBay returns payouts in all states from the last five years when omitted.
offsetNoZero-based number of payouts to skip; keep below 5000 for response time (eBay default 0)
marketplaceIdNoOverrides the X-EBAY-C-MARKETPLACE-ID header, e.g. EBAY_US, EBAY_GB or EBAY_DE. Defaults to EBAY_MARKETPLACE_ID; eBay assumes EBAY_US when the header is absent.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.18.0

TDQS

A4.1/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With readOnlyHint already declared, the description still adds real context: the requirement for the sell.finances scope, the EU/UK digital-signature requirement with the specific environment variables to set, the five-year data window, and the empty-result behavior (success with no data). That is substantive beyond the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four front-loaded sentences with little waste; the purpose and scope come first and the operational caveats follow. It is dense but every clause carries information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

No output schema exists, so the description has to cover return behavior, and it does note that an empty match still returns success. Auth and signing requirements are also covered. Only the absence of explicit sibling routing keeps it from being fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description still contributes by tying the parameters into a workflow — filter by payoutDate/payoutStatus, page with limit/offset, sort by payoutDate — which helps an agent see how the arguments combine rather than reading each in isolation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb and resource — listing seller payouts from the eBay Finances API — and pins the scope to the last five years. That is enough for an agent to tell it apart from the sibling single-payout and payout-summary tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It states which filters, paging, and sorting are available, so the usage pattern is implied. But it never says when to prefer this over the sibling ebay_get_payout or ebay_get_payout_summary, nor any prerequisite conditions beyond the scope requirement.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools