GET/api/v2.0/TransactionDetailReportPaginación: offsetLímite: 40 llamadas por minuto
Obtiene la información del detalle de transacciones de los comercios asociados a la cuenta token del usuario.
La información obtenida en este endpoint es la misma que se encuentra disponible en el detalle de transacciones de Bistroweb para el usuario logueado. Por usuario logueado se pueden hacer 40 request por minuto, sino devuelve 429.
La cantidad máxima de items por página es 500.
Parámetros de entrada
| startDate | Fecha de inicio del rango de fechas a consultar. Formato: yyyy-MM-dd |
| endDate | Fecha de fin del rango de fechas a consultar. Formato: yyyy-MM-dd |
| pageNumber | Página de datos requerida. La primera página es la 0 |
| shopCode | OPCIONAL -> Id del comercio que se quiere consultar, por defecto es null y se consultan todos los comercios del usuario logueado |
| version | Usar v1 |
Parámetros de salida
| Records | Cantidad de registros traídos por la consulta |
| TotalPages | Total de páginas |
| PageSize | Cantidad de items por página |
| TotalCount | Total de items en la consulta |
| items | Array con los items del detalle de transacciones |
| items.Comments | Comentarios de la transacción |
| items.Client | Cliente de la transacción, si aplica |
| items.Date | Fecha de la transacción en formato dd/MM/yyyy |
| items.Hour | Hora de la transacción en formato HH:mm:ss |
| items.Quantity | Cantidad de items consumidos, si aplica |
| items.Amount | Monto de la transación por el medio de pago, o monto del item consumido |
| items.Shop | Nombre del comercio |
| items.ShopCode | ID del comercio |
| items.TicketNumber | Nro de Ticket |
| items.TransactionType | Tipo de Transacción |
| items.Origin | Origen de la transacción (vereda, salón, Rappi, etc..) |
| items.Product | Nombre del producto, si aplica |
| items.PaymentMethod | Medio de pago de la transacción |
| items.User | Usuario que generó la transacción |
| items.Timestamp | Campo del tipo DateTime, con la fecha de cierre de la transacción |
| items.Status | Estado de la transacción |
| items.Uuid | Identificador único de la transacción en toda la plataforma |
| items.DinnersQty | Cantidad de comensales, si aplica |
| items.UnitPrice | Precio unitario del producto, si aplica |
| items.Vat | Monto de IVA |
| items.UnitCost | Costo unitario del producto al momento de la transacción, si aplica |
| items.TotalCost | Costo total del producto al momento de la transacción, si aplica |
| items.Sku | SKU del producto, si aplica |
| items.Category | Categoría del producto, si aplica |
| items.Waiter | Mozo/mesero/camarero que participó de la transacción, si aplica |
| items.TableName | Nombre de la mesa donde se suscribe la transacción, si aplica |
Información: ¿Para qué sirve?Devuelve el reporte transaccional detallado, pensado para análisis y auditoría más que para sincronizar. Tiene un límite de llamadas por minuto, así que conviene usarlo en procesos programados y no en pantallas interactivas.
Parámetros
Respuestas
200OK
- Página de Reporte de Transaccionesobject
- recordsinteger · int32
- totalPagesinteger · int32
- pageSizeinteger · int32
- totalCountinteger · int32
- itemsarray · admite nulo
404Not Found
- ProblemDetailsobject
- typestring · admite nulo
- titlestring · admite nulo
- statusinteger · int32 · admite nulo
- detailstring · admite nulo
- instancestring · admite nulo
429Too Many Requests
- ProblemDetailsobject
- typestring · admite nulo
- titlestring · admite nulo
- statusinteger · int32 · admite nulo
- detailstring · admite nulo
- instancestring · admite nulo