Skip to main content

List Orders

mailhub_list_orders

Page through the Orders of the account you signed in with — the tool an assistant reaches for first when it needs an orderId or shipmentId for anything else.

Permission and safety

Changes dataNo
ConfirmationNot required
Spends fundsNo
PermissionView access to Orders is enough

Input

FieldTypeRequiredDefaultNotes
pageintegerNo11-based. A value below 1 is treated as 1.
pageSizeintegerNo20Maximum 100. A value below 1 is treated as 20.

Pagination is the only control. There is no search, status filter, carrier filter, date range, or sort input.

Example input

{
"page": 1,
"pageSize": 20
}

Output

A page of Orders plus the paging metadata that tells you whether another page exists.

PartContents
ItemsOne entry per Order
PagingTotal item count, current page number and size, total pages, and whether a next or previous page exists

Each Order entry carries the Order identifier and the Shipment identifier when the Order has one, the Label identifier once a Label has been bought, the Order date, customer name and destination city, ZIP and country, carrier and service level, the Order status, and the ship date and tracking number when they exist.

Statuses come back as readable names with the numeric code alongside them, and every timestamp is UTC with a formatted companion value. The Mailhub application shows those same instants in your local timezone, so a time here and a time on screen can look different while meaning the same moment.

Rules and common tool-specific errors

  • Draft Orders are never listed. A Draft is a work-in-progress Order in the application, and MCP does not see it.
  • An empty page is a normal answer, both for an account with no Orders and for a page beyond the last one. Neither is an error.
  • The list covers the account you signed in with. MCP has no sub-account scope today.
  • To reach one specific Order, use mailhub_get_order with its identifier rather than expecting a filtered list.

This tool has few failure modes of its own. Access and shared failures — sign-in, permissions, rate guards — are listed in Errors & Troubleshooting.

Next