Skip to main content
Glama

PlentyONE MCP by usefulapi

plentymarkets_list_orders

Read-only

List orders (sales orders, returns, credit notes ...) with filters. Newest first with sort_by createdAt and sort_order desc. Returns {page, totalsCount, isLastPage, entries[]}; each entry has the id, typeId (1 = sales order), statusId, plentyId, createdAt, amounts and the order items unless add_order_items is false. GET /rest/orders.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, from 1 (default 1).
withNoRelated data to load, for example addresses, comments, payments, documents.
paid_toNoA date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day.
sort_byNo
order_idsNoSpecific order ids, comma separated.
paid_fromNoA date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day.
status_toNoOnly orders up to this status (combine with status_from for a range).
contact_idNoOnly orders of this contact (customer).
created_toNoA date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day.
order_typeNoOrder type id(s), comma separated: 1 sales order, 2 delivery order, 3 returns, 4 credit note, 5 warranty, 6 repair, 7 offer, 8 advance order, 9 multi order, 10 multi credit note, 11 multi delivery, 12 reorder, 13 partial delivery, 14 subscription, 15 redistribution.
sort_orderNo
updated_toNoA date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day.
referrer_idNoOnly orders from this order referrer / marketplace (see plentymarkets_list_order_referrers).
status_fromNoOnly orders in this status or a higher one (status ids are numbers like 3, 5.1, 7).
created_fromNoA date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day.
updated_fromNoA date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day.
items_per_pageNoEntries per page, 1 to 100 (default 25). When is_last_page is false, ask for the next page.
payment_statusNo
add_order_itemsNoInclude the order items (default true). false makes the page much smaller.
external_order_idNoThe order id the marketplace or shop gave the order.
included_variationNoOnly orders that contain this variation id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover safety (readOnlyHint=true, destructiveHint=false, openWorldHint=true), and the description adds real value on top: the pagination envelope, which fields each entry carries, and the notable default that order items are included unless disabled. It does not discuss rate limits or auth, which is a minor gap for an open-world read.

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?

Four compact sentences, front-loaded with purpose, then defaults, then return shape, then endpoint. Dense without padding; only the enumerated parenthetical "(sales orders, returns, credit notes ...)" is slightly loose.

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?

For a 21-parameter filter tool with no output schema, the description supplies the missing return contract (page, totalsCount, isLastPage, entries[] and entry fields) plus pagination and default-sort behavior. Pagination fields are named exactly as returned (isLastPage), so an agent can page correctly without guessing.

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 already 86%, so the baseline is 3; the description still earns more by stating the effective default ordering (sort_by=createdAt, sort_order=desc) and the payload-size consequence of add_order_items, neither of which is fully spelled out in the schema. It also clarifies that typeId 1 means sales order when reading results.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource ("List orders") and broadens scope explicitly to sales orders, returns, credit notes, plus the backing endpoint GET /rest/orders, which implicitly separates it from the single-order get_order sibling. It never names a sibling outright, so an agent must infer the list-vs-get boundary.

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

Usage Guidelines3/5

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

Useful operating hints are present — default sort is newest first, and add_order_items=false makes pages smaller — but there is no explicit statement of when to reach for this tool versus plentymarkets_get_order or plentymarkets_list_order_statuses. Usage is implied by the filter inventory rather than stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.