Reportes

Reporte de utilidad agrupado por proveedor de entrega

Genera un reporte de ventas a domicilio agrupadas y totalizadas por proveedor de entrega (RAPPI, Uber Eats, Didi Food, Interno, etc.).

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

Características del reporte:

  • Solo incluye facturas con entrega a domicilio (delivery.isDelivery: true)
  • Solo facturas en estado "Pagada"
  • Agrupa y totaliza por proveedor de entrega
  • Útil para comparar performance entre canales de delivery
  • Soporte para usuarios con múltiples negocios

Casos de uso:

  • Análisis de rentabilidad por canal de delivery
  • Comparación de comisiones vs ingresos por proveedor
  • Decisiones sobre alianzas con plataformas de entrega
  • Reporte de ventas por canal para gerencia

Ejemplos de uso:

1. Utilidad por proveedor de entrega del mes

GET /reports/reportUtilityDeliveryProvider?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-31T23:59:59.999Z
Authorization: Bearer tu_token_aqui

2. Utilidad multi-negocio por proveedor de entrega

GET /reports/reportUtilityDeliveryProvider?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-31T23:59:59.999Z&allBusiness=true
Authorization: Bearer tu_token_aqui
get/reports/reportUtilityDeliveryProvider

Request

  • Base URL
    https://api.pirpos.com
  • URL
    https://api.pirpos.com/reports/reportUtilityDeliveryProvider
  • Auth
    HTTP bearer

Query parameters

dateInitISOstring date-time

Fecha inicial del período (formato ISO)

dateEndISOstring date-time

Fecha final del período (formato ISO)

allBusinessboolean

Incluir todos los negocios del usuario (para usuarios multi-negocio)

Response

Reporte de utilidad por proveedor de entrega generado exitosamente

totalnumber

Total de ventas del proveedor en el período

countnumber

Cantidad de órdenes del proveedor

deliveryCostnumber

Total de costo de envío cobrado

Example response

[
  {
    "_id": {
      "deliveryProvider": "RAPPI"
    },
    "total": 850000,
    "count": 25,
    "deliveryCost": 200000
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.