plentymarkets_list_orders
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
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). | |
| with | No | Related data to load, for example addresses, comments, payments, documents. | |
| paid_to | No | A date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day. | |
| sort_by | No | ||
| order_ids | No | Specific order ids, comma separated. | |
| paid_from | No | A date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day. | |
| status_to | No | Only orders up to this status (combine with status_from for a range). | |
| contact_id | No | Only orders of this contact (customer). | |
| created_to | No | A date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day. | |
| order_type | No | Order 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_order | No | ||
| updated_to | No | A date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day. | |
| referrer_id | No | Only orders from this order referrer / marketplace (see plentymarkets_list_order_referrers). | |
| status_from | No | Only orders in this status or a higher one (status ids are numbers like 3, 5.1, 7). | |
| created_from | No | A date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day. | |
| updated_from | No | A date (yyyy-mm-dd) or a date-time (2026-10-24T13:33:23+02:00). A bare date means the whole day. | |
| items_per_page | No | Entries per page, 1 to 100 (default 25). When is_last_page is false, ask for the next page. | |
| payment_status | No | ||
| add_order_items | No | Include the order items (default true). false makes the page much smaller. | |
| external_order_id | No | The order id the marketplace or shop gave the order. | |
| included_variation | No | Only orders that contain this variation id. |