Skip to main content
Glama

QuailOS

by com.quailos
OverviewDiscussionsAdmin

get_orders

Read-onlyIdempotent

Retrieve the farm's sales orders (manual, connected stores and incoming dropships), newest first. Returns { totalMatches, totalMatchesIsExact, truncated, hasMore, nextCursor, orders }. For connected store orders, includes marketplaceStatus and marketplaceFulfillmentStatus raw values. To get the next page, call again with the SAME filters and cursor set to nextCursor exactly as returned; nextCursor is null on the last page (offset/page are not supported). For stale-order checks use unfulfilledOnly: true with olderThanDays (or createdBefore) instead of paging through everything. Supports startDate and endDate filters (YYYY-MM-DD = that whole day in the farm's local time zone, default America/New_York, inclusive; or ISO 8601 datetime). Each order includes shippingName (recipient name), shippingZip (ZIP/postal code), shippingState (US state/province code, e.g. TX, CA) and shippingCountry (country code, e.g. US); no street, phone or email, and salesChannel (amazon, tiktok, shopify_collective, temu, shopify, ebay, wix, squarespace, manual, dropship). Filter with salesChannel or shippingState. Requires farmId and apiKey authorization.

Input Schema

NameRequiredDescriptionDefault
limitNoOptional max number of orders to return (default 50, max 100)
cursorNoOptional pagination cursor: the nextCursor string from the previous get_orders response, passed verbatim with the same filters. Not an order id or page number.
farmIdYesThe unique farm ID
statusNoOptional filter: pending, partially_fulfilled, fulfilled, unfulfilled, shipped, etc.
endDateNoYYYY-MM-DD = that whole day in the farm's local time zone (default America/New_York), inclusive; or ISO 8601 datetime
startDateNoYYYY-MM-DD = that whole day in the farm's local time zone (default America/New_York), inclusive; or ISO 8601 datetime
salesChannelNoOptional. Only orders from this sales channel. amazon / tiktok / shopify_collective / temu are detected on Shopify-synced orders (precedence amazon > tiktok > shopify_collective > temu; tiktok = TikTok Shop orders); shopify = direct Shopify orders only; ebay, wix, squarespace = that connected store; manual = orders entered in QuailOS; dropship = incoming dropship requests. Use the same value on every page.
createdBeforeNoOptional. Only orders placed before this date (YYYY-MM-DD = start of that day in farm time, or ISO datetime; exclusive).
olderThanDaysNoOptional. Only orders placed more than N days ago (0-3650). Frozen at page 1 so paging stays consistent.
shippingStateNoOptional. Filter orders by US state/province code (e.g. TX, CA, KY). Matches normalized 2-letter uppercase state code. Use the same value on every page.
unfulfilledOnlyNoOptional. true = only orders that still need fulfilment (excludes fulfilled, shipped, delivered, completed, cancelled, refunded).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / endDate / description
      Previous value: -"Optional end date range filter (YYYY-MM-DD or ISO datetime)"New value: +"YYYY-MM-DD = that whole day in the farm's local time zone (default America/New_York), inclusive; or ISO 8601 datetime"
    • changedInput schema / properties / startDate / description
      Previous value: -"Optional start date range filter (YYYY-MM-DD or ISO datetime)"New value: +"YYYY-MM-DD = that whole day in the farm's local time zone (default America/New_York), inclusive; or ISO 8601 datetime"
  2. Changed2 schema fields changed
    • changedInput schema / properties / salesChannel / description
      Previous value: -"Optional. Only orders from this sales channel. amazon / shopify_collective / temu are detected on Shopify-synced orders (precedence amazon > shopify_collective > temu); shopify = direct Shopify orders only; ebay, wix, squarespace = that connected store; manual = orders entered in QuailOS; dropship = incoming dropship requests. Use the same value on every page."New value: +"Optional. Only orders from this sales channel. amazon / tiktok / shopify_collective / temu are detected on Shopify-synced orders (precedence amazon > tiktok > shopify_collective > temu; tiktok = TikTok Shop orders); shopify = direct Shopify orders only; ebay, wix, squarespace = that connected store; manual = orders entered in QuailOS; dropship = incoming dropship requests. Use the same value on every page."
    • changedInput schema / properties / salesChannel / enum
      Previous value: -[
-  "amazon",
-  "shopify_collective",
-  "temu",
-  "shopify",
-  "ebay",
-  "wix",
-  "squarespace",
-  "manual",
-  "dropship"
-]New value: +[
+  "amazon",
+  "tiktok",
+  "shopify_collective",
+  "temu",
+  "shopify",
+  "ebay",
+  "wix",
+  "squarespace",
+  "manual",
+  "dropship"
+]
  3. Changed6 schema fields changed
    • addedInput schema / properties / createdBefore
      Added value: +{
+  "description": "Optional. Only orders placed before this date (YYYY-MM-DD = start of that day in farm time, or ISO datetime; exclusive).",
+  "type": "string"
+}
    • changedInput schema / properties / cursor / description
      Previous value: -"Optional pagination cursor"New value: +"Optional pagination cursor: the nextCursor string from the previous get_orders response, passed verbatim with the same filters. Not an order id or page number."
    • addedInput schema / properties / olderThanDays
      Added value: +{
+  "description": "Optional. Only orders placed more than N days ago (0-3650). Frozen at page 1 so paging stays consistent.",
+  "type": "number"
+}
    • addedInput schema / properties / salesChannel
      Added value: +{
+  "description": "Optional. Only orders from this sales channel. amazon / shopify_collective / temu are detected on Shopify-synced orders (precedence amazon > shopify_collective > temu); shopify = direct Shopify orders only; ebay, wix, squarespace = that connected store; manual = orders entered in QuailOS; dropship = incoming dropship requests. Use the same value on every page.",
+  "enum": [
+    "amazon",
+    "shopify_collective",
+    "temu",
+    "shopify",
+    "ebay",
+    "wix",
+    "squarespace",
+    "manual",
+    "dropship"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / shippingState
      Added value: +{
+  "description": "Optional. Filter orders by US state/province code (e.g. TX, CA, KY). Matches normalized 2-letter uppercase state code. Use the same value on every page.",
+  "type": "string"
+}
    • addedInput schema / properties / unfulfilledOnly
      Added value: +{
+  "description": "Optional. true = only orders that still need fulfilment (excludes fulfilled, shipped, delivered, completed, cancelled, refunded).",
+  "type": "boolean"
+}
  4. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, so the safety profile is covered. The description still adds real behavior beyond that: the exact response envelope keys, cursor stability rules (nextCursor null on last page, olderThanDays frozen at page 1), and data-privacy boundaries (no street, phone or email). Strong, though it does not mention rate limits or auth-scope nuances.

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?

Front-loads the purpose and return shape, then groups pagination, stale-order guidance, date semantics, field availability and filters. Dense but every section earns its place; slightly long for an agent skimming, but no filler sentences.

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?

With 11 parameters and no output schema, the description compensates fully by enumerating the return fields, pagination contract, filter interactions and auth requirement. An agent can call this correctly without further reference.

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, and the description genuinely adds meaning on top: date filters interpreted as whole local days (America/New_York, inclusive), salesChannel precedence for Shopify-synced orders, normalized 2-letter shippingState, and the constraint that filters must stay identical across pages.

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?

States a specific verb and resource ('Retrieve the farm's sales orders') and immediately scopes it to three sources (manual, connected stores, incoming dropships) with an ordering rule (newest first). This is enough for an agent to distinguish it from siblings like get_order_feedback or get_transactions.

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

Usage Guidelines5/5

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

Gives explicit when-to-use guidance: paginate by re-calling with the SAME filters and nextCursor verbatim, and rules out offset/page. It also names a concrete alternative workflow for stale-order checks (unfulfilledOnly + olderThanDays/createdBefore 'instead of paging through everything').

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

All QuailOS toolsInspect
Try in Browser
Pay for results, not tokens.Fund a bounty. Let AI agents compete and collaborate to solve your problems.agentbounties.appAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources