Listar ítems finalizados
GET
https://api.copayex.com/api/v1/items/finishedParámetros de solicitud
| Campo | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
pageSize | number | Query | No | Cantidad por página. |
pageIndex | number | Query | No | Página (base 0). |
query | string | Query | No | Texto libre. |
dateFrom | string (ISO8601) | Query | No | Fecha inicial. |
dateTo | string (ISO8601) | Query | No | Fecha final. |
Parámetros de respuesta
Devuelve un listado paginado de ítems finalizados ([{ ... }]). Campos principales:
| Campo | Tipo | Descripción |
|---|---|---|
id | number | Identificador interno del ítem. |
number | number | Consecutivo recomendado para su uso en frontend. |
uuid | string | Identificador global del ítem. |
amount | number | Monto total del ítem. |
amountPayed | number | Monto pagado (debería coincidir con amount al estar finished). |
title | string | Nombre del ítem. |
description | string | Descripción opcional. |
status | "active" | "finished" | "void" | Estado del ítem (en este endpoint se esperan finished). |
paymentMethods | string[] | Métodos de pago habilitados. |
staticQr | StaticQr | null | null si no hay QR asociado; de lo contrario, ID del QR estático. |
pageIndex | number | Índice actual devuelto cuando se envía en la query. |
pageSize | number | Tamaño de página aplicado cuando se envía en la query. |
total | number | Total de ítems que cumplen el filtro. |
createdAt | string (ISO8601) | Fecha de creación. |
Ejemplos de solicitud
curl -G "https://api.copayex.com/api/v1/items/finished" \
-H "Authorization: Bearer <client_access_token>" \
--data-urlencode "pageIndex=0" \
--data-urlencode "pageSize=20"Respuesta de ejemplo
{
"data": [
{
"uuid": "481165df-8b66-42b1-9f66-74d6e3ebbb87",
"number": 1,
"id": 1,
"amount": 1000,
"amountPayed": 1000,
"title": "Combo latte",
"description": "Café + medialunas",
"createdAt": "2025-11-04T19:10:30.000Z",
"status": "finished",
"paymentMethods": ["mercadopago"]
}
]
}