Skip to content
docs
Guides
ES
OrdersAgent Read
order:read

List order summaries for agent tools

GET/v1/agent-read/orders

List order summaries for agent tools. A successful request returns HTTP 200 with the documented response body.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

search?string

Free-text filter. Which fields it covers depends on the resource.

status?string

Only items in these statuses.

Value in

  • "new"
  • "confirmed"
  • "inProgress"
  • "invoiced"
  • "readyToPickUp"
  • "inTransit"
  • "delivered"
  • "partialDelivered"
  • "closed"
  • "cancelled"
  • "invalid"
  • "pendingToConfirm"
  • "pendingToDeliveredToClient"
  • "returned"
  • "partialReturned"
  • "partialCancelled"
  • "none"
from?string
Formatdate-time
to?string
Formatdate-time
limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/agent-read/orders" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "orders": [    {      "id": "7204558912004325301",      "number": "example",      "date": "2026-08-01T15:30:00Z",      "status": "new",      "fulfillmentStatus": "unfulfilled",      "currency": "PEN",      "total": 1,      "source": "example",      "sellerId": "7204558912004325301"    }  ],  "hasNextPage": false,  "nextCursor": "example"}