ActionShip by Teapplix Demo

Get Orders

teapplix_get_orders

Read-only

Download / query orders from Teapplix. At least one of the following is required: TxnId, QueueId, Tag, SeqStart, SeqEnd, PaymentDateStart, PaymentDateEnd, UpdateDateStart, UpdateDateEnd, ShipDateStart, ShipDateEnd, or Shipped=0. IMPORTANT: results are paginated — loop through all pages using PageNumber until PageNumber >= Pagination.TotalPages. [DEMO]

Input Schema

TableJSON Schema

Name	Required	Description
`Tag`	No	Filter by order tag name. Comma-separate multiple names (e.g. "urgent,vip") to match orders with any of those tags.
`TxnId`	No	Unique Teapplix order ID. Use to fetch a single order.
`SeqEnd`	No	TxnSequence <= this value (inclusive).
`Combine`	No	Combined-order handling. Default: combine.
`Invoice`	No	Marketplace order number / invoice number.
`QueueId`	No	Queue ID. 0 = Normal queue.
`Shipped`	No	0 = unshipped/open orders only; 1 = shipped orders only.
`PageSize`	No	Records per page (default 100, max 1000). Use PageSize=1000 to minimize round-trips when iterating all pages.
`SellerId`	No	eBay username or Amazon merchant ID.
`SeqStart`	No	TxnSequence >= this value (inclusive). Ideal for incremental polling.
`StoreKey`	No	3-letter cart prefix, or 2-letter country code for Amazon.
`StoreType`	No	Marketplace type, e.g. ebay, amazon, walmart, shopify.
`PageNumber`	No	Page number, 1-indexed. Response includes data.Pagination.TotalPages — iterate from PageNumber=1 up to TotalPages to retrieve all orders. Response orders are in data.Orders array.
`DetailLevel`	No	Additional data: none, shipping, inventory, dropship, marketplace. Pipe-separate multiple values.
`ShipDateEnd`	No	Ship date <= value (YYYY/MM/DD). Interpreted as Pacific timezone.
`WarehouseId`	No	Filter by warehouse ID.
`PaymentStatus`	No	Filter by payment status.
`ShipDateStart`	No	Ship date >= value (YYYY/MM/DD). Shipped orders only. Interpreted as Pacific timezone.
`UpdateDateEnd`	No	LastUpdateDate <= value (YYYY/MM/DD). Interpreted as Pacific timezone.
`PaymentDateEnd`	No	Payment date <= value (YYYY/MM/DD). Interpreted as Pacific timezone.
`UpdateDateStart`	No	LastUpdateDate >= value (YYYY/MM/DD). Interpreted as Pacific timezone.
`PaymentDateStart`	No	Payment date >= value (YYYY/MM/DD). Interpreted as Pacific timezone.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`Orders`	No
`Pagination`	No

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=true, so the read-only nature is known. The description adds valuable behavioral context: the requirement for at least one filter and the pagination loop (PageNumber until >= TotalPages), which are not derivable from annotations. This goes beyond the structured metadata.

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?

The description is concise and front-loaded with the main purpose. The list of acceptable filter parameters is necessary and not wasteful. The 'IMPORTANT' pagination note is a useful highlight. The trailing '[DEMO]' is minor noise but doesn't detract significantly.

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?

Given the tool's complexity (22 parameters) and the presence of an output schema, the description covers the two most critical operational aspects: mandatory filter requirement and pagination. It doesn't need to explain return structure since the output schema exists. This is adequate and complete for safe invocation.

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 description coverage is 100%, so the baseline is 3. The description adds cross-parameter semantics by enumerating which parameters can satisfy the 'at least one required' constraint, and clarifies pagination parameters' relationship. This is meaningful additive value beyond individual schema descriptions.

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 clearly states the tool's function: 'Download / query orders from Teapplix.' This is a specific verb+resource combination that distinguishes it from sibling tools like teapplix_create_order, teapplix_update_order, and teapplix_manage_order_tags. The scope is unambiguous.

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

Usage Guidelines4/5

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

The description provides clear usage context by specifying that at least one of several filters is required (TxnId, QueueId, Tag, etc.) and gives explicit pagination instructions. It doesn't explicitly mention alternatives or when-not-to-use, but the required-filter condition is strong guidance for correct invocation.

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

All ActionShip by Teapplix Demo tools Inspect

Try in Browser

RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0

Disambiguation4/5

Most tools have clearly distinct purposes (orders, labels, rates, zones, profiles). A few name pairs like manage_tag vs manage_order_tags and set_order_ship_options vs update_order could be confused, but the descriptions explicitly clarify when to use each.

Naming Consistency5/5

All tools share the teapplix_ prefix and follow a consistent verb_noun pattern (e.g., get_orders, create_order, purchase_label, validate_address). The only deviation is the bare 'help' tool, which is conventional and does not disrupt the pattern.

Tool Count4/5

At 28 tools, the server is slightly over the ideal 3-15 range, but the breadth of shipping operations (orders, labels, rates, manifests, tracking, configuration) justifies the count. It is not bloated.

Completeness5/5

The tool surface covers the full order-to-shipping lifecycle: order create/update/retrieve, splitting/merging, label purchase and cancellation, rate quotes, tracking, manifesting, address validation, 3PL submission, and configuration (profiles, warehouses, queues, tags). No significant gaps are apparent.

Resources

Need Help?