Skip to main content

Get Order

mailhub_get_order

Read one Order and the first Shipment Mailhub can resolve for it: addresses, where it stands, and what can be done to it next.

Permission and safety

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

Input

FieldTypeRequiredNotes
orderIdstringYesThe Order's UUID. Checked for shape before the call is made.

Example input

{
"orderId": "11111111-1111-1111-1111-111111111111"
}

Output

The Order detail, grouped as:

  • Order information — identifiers, dates, and the current status;
  • Shipment information — parcel and service detail, and the Label state when a Label exists;
  • Addresses — sender and recipient;
  • Status history — what the Order has moved through, and why, where a reason was recorded;
  • Available actions — what Mailhub currently allows for this Order.

Statuses arrive as readable names with the numeric code alongside, and timestamps are UTC with a formatted companion value.

Rules and common tool-specific errors

  • One Shipment per call. The tool resolves the Order's first listed Shipment, so an Order with more than one Shipment is not fully represented here.
  • Draft Orders are not reachable. Drafts are excluded from Order listings, and this tool resolves the Order through that listing.
  • An Order belonging to another account is not found — the same answer as an Order that does not exist. That is deliberate isolation, not a bug.
CodeWhat it meansRetrying
MCP_INVALID_UUIDorderId is not a UUIDNo — fix the value
MCP_ORDER_DETAILS_UNAVAILABLEMailhub could not resolve a Shipment for this Order. It may not exist, may be a Draft, or may not have a Shipment yetNo — check the Order in Mailhub

Access and shared failures live in Errors & Troubleshooting.

Next