Saltar al contenido
docs
Guías
EN
PedidosLecturas para agentes
order:read

Listar pedidos para agentes

GET/v1/agent-read/orders

Listar pedidos para agentes. Una solicitud exitosa devuelve HTTP 200 con el cuerpo de respuesta documentado.

Autorización

bearerAuth
AutorizaciónBearer <token>

Token de acceso OAuth 2.0 emitido por Ecomiq Auth.

Ubicación: header

Parámetros de consulta

search?string

Filtro de texto libre. Los campos consultados dependen del recurso.

status?string

Solo elementos en estos estados.

Valor en

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

Cantidad máxima de resultados por devolver.

Formatoint32
cursor?string

Cursor opaco de la respuesta anterior. Omítelo en la primera página.

Parámetros de cabecera

x-Store-Id?string

Tienda sobre la que actúa la solicitud. No hace falta cuando el token ya está vinculado a una tienda.

Authorization*string

Token bearer OAuth 2.0.

Cuerpo de la respuesta

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"}