Reportes

Consultar las ventas detallado por productos

Genera un reporte detallado de ventas organizadas por productos individuales en un período específico.

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}

Suscripción Premium requerida: Este endpoint requiere una suscripción premium activa.

Características del reporte:

  • Desglose detallado por producto individual
  • Información de cantidades vendidas y precios
  • Datos financieros completos (bruto, descuentos, impuestos, total)
  • Información de vendedores y cajeros
  • Datos de facturación y métodos de pago
  • Información de entrega a domicilio cuando aplique
  • Cálculo de costos promedio y promociones aplicadas

Opciones de agrupación:

  • Vista detallada: Cada línea de producto por factura
  • Vista agrupada: Totales consolidados por producto (usar groupResult=true)

Casos de uso:

  • Análisis de performance de productos específicos
  • Seguimiento de vendedores por producto
  • Control de inventario basado en ventas
  • Análisis de rentabilidad por producto
  • Reportes de comisiones por vendedor
  • Optimización de mix de productos

Ejemplos de uso:

1. Reporte básico de productos con parámetros requeridos

Ejemplo mínimo funcional con solo los parámetros obligatorios:

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

2. Reporte detallado de productos del mes

Vista línea por línea de todas las ventas de productos en agosto:

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

3. Reporte consolidado por productos

Vista agrupada con totales por producto para análisis de performance:

GET /reports/reportSalesByProduct?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-06T23:59:59.999Z&groupResult=true
Authorization: Bearer tu_token_aqui

4. Análisis de productos con combos incluidos

Reporte incluyendo productos que forman parte de combos:

GET /reports/reportSalesByProduct?dateInitISO=2025-08-06T00:00:00.000Z&dateEndISO=2025-08-06T23:59:59.999Z&showProductCombo=true
Authorization: Bearer tu_token_aqui

5. Reporte de productos por vendedor

Análisis detallado para evaluación de comisiones y performance:

GET /reports/reportSalesByProduct?dateInitISO=2025-08-01T00:00:00.000Z&dateEndISO=2025-08-06T23:59:59.999Z&status=Pagada
Authorization: Bearer tu_token_aqui

6. Análisis multi-negocio

Reporte consolidado de productos para usuarios con múltiples negocios:

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

7. Reporte de productos del día para análisis rápido

Vista diaria consolidada para revisión rápida de performance:

GET /reports/reportSalesByProduct?dateInitISO=2025-08-22T00:00:00.000Z&dateEndISO=2025-08-22T23:59:59.999Z&groupResult=true&status=Pagada
Authorization: Bearer tu_token_aqui
get/reports/reportSalesByProduct

Request

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

Query parameters

dateInitISOstring date-time required

Fecha inicial del período del reporte (formato ISO)

dateEndISOstring date-time required

Fecha final del período del reporte (formato ISO)

status'Pagada' | 'Facturada'

Filtrar por estado específico de facturas (por defecto excluye Anulada)

groupResultboolean

Agrupar resultados por producto (consolidado) en lugar de vista detallada

showProductComboboolean

Incluir productos que forman parte de combos

allBusinessboolean

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

Response

Reporte de ventas por productos generado exitosamente

Example response

{
  "reportByProduct": [
    {
      "_id": {
        "_id": "507f1f77bcf86cd799439030",
        "business": {
          "name": "Restaurante El Buen Sabor"
        },
        "seller": "Ana García",
        "cashier": "Carlos López",
        "categoryName": "Hamburguesas",
        "code": "HAM001",
        "name": "Hamburguesa Clásica",
        "number": "FAC-001",
        "table": "Mesa 5",
        "quantity": 2,
        "priceNormal": 15000,
        "avgCost": 8000,
        "deliveryProviderName": "RAPPI"
      },
      "mainSeller": "María Rodríguez",
      "totalBruto": 30000,
      "totalDiscount": 3000,
      "totalTaxes": 5130,
      "totalBaseTax": 27000,
      "total": 32130
    }
  ]
}

Changes

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