Premiados

Endpoints para consulta de premiaciones y sorteos.

Listar Premiados

GET /api/awardeds

Retorna una lista paginada de premiados con opciones de filtro por intervalo de fechas y premios específicos. Este endpoint proporciona acceso a los premios del programa de fidelidad y registros ganadores con información de la empresa y del cliente.

Casos de uso:

• Consultar ganadores de promociones
• Exportar lista de premiados
• Integrar con sistema de entrega de premios

Parámetros de Query

Parámetro	Tipo	Obligatorio	Descripción
date_start	string	Sí	Fecha de inicio para filtrar registros (YYYY-MM-DD)
date_end	string	Sí	Fecha de fin para filtrar registros (YYYY-MM-DD)
limit	integer	Sí	Número de registros por solicitud
offset	integer	Sí	Número de registros a omitir (mínimo 0)
awardeds_id	array	No	IDs específicos de premios para filtrar (UUIDs)

Ejemplo de Solicitud

curl -X GET "https://api-b2s.experienciab2s.com/api/awardeds?date_start=2024-01-01&date_end=2024-12-31&limit=50&offset=0" \
     -H "Authorization: Bearer SU_TOKEN"

Respuesta Exitosa (200)

{
  "total": 125,
  "limit": 50,
  "offset": 0,
  "data": [
    {
      "id": "abc123e4-56f7-89ab-cdef-123456789abc",
      "created_at": "2024-04-15T10:30:00.000Z",
      "awarded": {
        "id": "def456g7-89hi-01jk-lmno-456789012def",
        "name": "Sorteo Mensual Premium"
      },
      "client": {
        "id": "ghi789j0-12kl-34mn-opqr-789012345ghi",
        "name": "María García",
        "email": "maria.garcia@example.com",
        "phone": "(11) 99999-9999",
        "born_date": "1985-03-15T00:00:00.000Z"
      },
      "company": {
        "id": "jkl012m3-45no-67pq-rstu-012345678jkl",
        "name": "Restaurante Buen Sabor"
      }
    },
    {
      "id": "mno345p6-78qr-90st-uvwx-345678901mno",
      "created_at": "2024-04-14T14:20:00.000Z",
      "awarded": {
        "id": "pqr678s9-01tu-23vw-xyza-678901234pqr",
        "name": "Cashback Semanal"
      },
      "client": {
        "id": "stu901v2-34wx-56yz-abcd-901234567stu",
        "name": "Juan Santos",
        "email": "juan.santos@example.com",
        "phone": null,
        "born_date": null
      },
      "company": {
        "id": "vwx234y5-67za-89bc-defg-234567890vwx",
        "name": "Tienda de Electrónicos Tech"
      }
    }
  ]
}

Estructura de la Respuesta

Campo	Tipo	Descripción
total	integer	Total de registros disponibles
limit	integer	Límite por página
offset	integer	Offset actual
data	array	Lista de premiados

Estructura del Premiado

Campo	Tipo	Descripción
id	string	ID único del registro
created_at	string	Fecha de creación
awarded.id	string	ID del premio
awarded.name	string	Nombre del premio
client.id	string	ID del cliente
client.name	string	Nombre del cliente
client.email	string	Email del cliente
client.phone	string	Teléfono del cliente
client.born_date	string	Fecha de nacimiento
company.id	string	ID de la empresa
company.name	string	Nombre de la empresa

Códigos de Respuesta

Código	Descripción
200	Premiados encontrados
403	Token inválido o usuario no autorizado
404	Token de integración no encontrado