Skip to main content
Glama

list_orders

Retrieve paginated orders with filters by status, shop, warehouse, platform, date range, or search by order code, transaction number, or tracking number.

Instructions

List orders with filters. Returns paginated results.

IMPORTANT for AI:

  • Use 'q' to search by order code, transaction number, or tracking number.

  • Use date range filters to narrow results.

  • Response 'meta.pagination' has total, total_pages, current_page for pagination.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoSearch by order code, transaction number, or tracking number
statusNoOrder status (call get_sys_helpers for valid values)
shop_idNoFilter by shop ID
warehouse_idNoFilter by warehouse ID
platformNoFilter by platform (1=shopee, 2=lazada, 3=tiktokshop, 4=tiki, 5=pancake, 6=pos)
start_create_dateNoCreation date range start (YYYY-MM-DD)
end_create_dateNoCreation date range end (YYYY-MM-DD)
sortNoSort order (default id:-1 = newest first)id:-1
limitNoPage size (default 25)
pageNoPage number (1-indexed)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior4/5

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

With no annotations, the description fully carries the burden. It states the tool returns paginated results and describes the pagination response structure ('meta.pagination'). It doesn't mention side effects, which are not expected for a list operation. The description is transparent enough.

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

Conciseness5/5

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

The description is concise: two brief sentences plus a short 'IMPORTANT for AI' section. Every sentence adds value and is front-loaded with key info. No unnecessary words.

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

Completeness5/5

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

Given that an output schema exists (context signal: true), the description doesn't need to detail return values. It covers usage, filters, pagination, and sorting. For a list tool, this is 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 baseline is 3. The description adds value by explaining how to use 'q', date range filters, and pagination. It also mentions the default sort. This goes beyond the parameter descriptions in the schema.

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 'List orders with filters. Returns paginated results.', specifying the action (list), resource (orders), and key features (filters, pagination). It distinguishes from sibling tools like 'get_order' (single order) and 'search_all_orders' (different search scope).

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 'IMPORTANT for AI' section provides concrete guidance: using 'q' for search, date range filters, and pagination handling. It doesn't explicitly exclude scenarios or mention alternative tools, but the context for use is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Winter279/gobox-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server