Order Read Tool
order-readRead-only
List or show visible orders with filtering, sorting and pagination.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for "list". Default 1. | |
| sort | No | Sort fields for "list". Append :asc or :desc for direction (default :asc). Example: ["created_at:desc"]. Available fields: id, number, user_id, invoice_id, subscription_id, service_id, service, date_started, date_due, next_task_due_at, nearest_due_at, date_completed, status, price, quantity, deadline, note, sort_order, last_message_at, created_at, updated_at, provider_order_id, provider_status, provider_error, deleted_at, orders.id, orders.number, orders.user_id, orders.invoice_id, orders.subscription_id, orders.service_id, orders.service, orders.date_started, orders.date_due, orders.next_task_due_at, orders.nearest_due_at, orders.date_completed, orders.status, orders.price, orders.quantity, orders.deadline, orders.note, orders.sort_order, orders.last_message_at, orders.created_at, orders.updated_at, orders.provider_order_id, orders.provider_status, orders.provider_error, orders.deleted_at, employees, audits, rating, ratings, followers, morphMetadata, user, invoice, options, subscription, order_service, order_status, forms, addons, tickets, tasks, workflowSteps, media, linkedOrdersAsSource, linkedOrdersAsTarget, trackedTimes, pipelineItems, tags, collaborators, filledFormFields, logs, messages, scheduledMessages, notifications. | |
| limit | No | Results per page for "list". Default 20, max 100. | |
| action | Yes | Action to perform. | |
| filters | No | Purity filter object for "list". Keys are field names, values are operator objects. Example: {"status":{"$eq":1}}. Available fields: id, number, user_id, invoice_id, subscription_id, service_id, service, date_started, date_due, next_task_due_at, nearest_due_at, date_completed, status, price, quantity, deadline, note, sort_order, last_message_at, created_at, updated_at, provider_order_id, provider_status, provider_error, deleted_at, orders.id, orders.number, orders.user_id, orders.invoice_id, orders.subscription_id, orders.service_id, orders.service, orders.date_started, orders.date_due, orders.next_task_due_at, orders.nearest_due_at, orders.date_completed, orders.status, orders.price, orders.quantity, orders.deadline, orders.note, orders.sort_order, orders.last_message_at, orders.created_at, orders.updated_at, orders.provider_order_id, orders.provider_status, orders.provider_error, orders.deleted_at, employees, audits, rating, ratings, followers, morphMetadata, user, invoice, options, subscription, order_service, order_status, forms, addons, tickets, tasks, workflowSteps, media, linkedOrdersAsSource, linkedOrdersAsTarget, trackedTimes, pipelineItems, tags, collaborators, filledFormFields, logs, messages, scheduledMessages, notifications. Status filter key is "status" (numeric IDs, not string names): 1=Pending, 2=Submitted, 3=Complete, 4=Canceled, 5=Working. | |
| order_number | No | Order number. Required for "show" actions. |