Skip to main content
GET
/
admin
/
orders
Listar órdenes persistidas (paginado)
curl --request GET \
  --url https://api.artisn.desarrollo-redbrand.com/api/admin/orders \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "orderId": "<string>",
      "status": "<string>",
      "payload": {},
      "enrichedPayload": {},
      "webhookAttempts": 123,
      "storeId": "<string>",
      "source": "<string>",
      "webhookLastResponse": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 1,
  "page": 2,
  "pageSize": 2,
  "totalPages": 1
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Página (base 1).

Required range: x >= 1
pageSize
integer
default:20

Tamaño de página (máximo 100).

Required range: 1 <= x <= 100
storeId
string

Filtrar por store_id.

source
string

Filtrar por origen (ej. pos).

status
string

Filtrar por estado (ej. ENRICHED).

q
string

Subcadena en order_id (búsqueda case-insensitive; % y _ literales escapados).

createdFrom
string<date-time>

Inclusive: filtra created_at >= este instante. Usar ISO 8601 con zona explícita (ej. 2025-06-15T00:00:00.000Z) para evitar ambigüedad local vs UTC. Si se envían createdFrom y createdTo, debe cumplirse createdFrom <= createdTo (si no, 400).

createdTo
string<date-time>

Inclusive: filtra created_at <= este instante. Un día calendario completo suele requerir el fin del día en UTC (ej. 2025-06-15T23:59:59.999Z), no solo T00:00:00, para no excluir órdenes creadas después de medianoche ese día. Misma regla de orden que createdFrom.

webhookAttemptsMin
integer

Mínimo de webhook_attempts.

Required range: x >= 0
webhookAttemptsMax
integer

Máximo de webhook_attempts.

Required range: x >= 0

Response

Página de resultados

items
object[]
required
total
integer
required

Total de filas que cumplen los filtros (sin paginar).

Required range: x >= 0
page
integer
required
Required range: x >= 1
pageSize
integer
required
Required range: x >= 1
totalPages
integer
required

Número de páginas; 0 si no hay resultados.

Required range: x >= 0