Premiados

Endpoints para consulta de premiações e sorteios.

Listar Premiados

GET /api/awardeds

Retorna uma lista paginada de premiados com opções de filtro por intervalo de datas e prêmios específicos. Este endpoint fornece acesso aos prêmios do programa de fidelidade e registros vencedores com informações da empresa e do cliente.

Casos de uso:

• Consultar ganhadores de promoções
• Exportar lista de premiados
• Integrar com sistema de entrega de prêmios

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
date_start	string	Sim	Data de início para filtrar registros (YYYY-MM-DD)
date_end	string	Sim	Data de fim para filtrar registros (YYYY-MM-DD)
limit	integer	Sim	Número de registros por requisição
offset	integer	Sim	Número de registros a pular (mínimo 0)
awardeds_id	array	Não	IDs específicos de prêmios para filtrar (UUIDs)

Exemplo de Requisição

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 SEU_TOKEN"

Resposta de Sucesso (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": "Sorteio Mensal Premium"
      },
      "client": {
        "id": "ghi789j0-12kl-34mn-opqr-789012345ghi",
        "name": "Maria Silva",
        "email": "maria.silva@example.com",
        "phone": "(11) 99999-9999",
        "born_date": "1985-03-15T00:00:00.000Z"
      },
      "company": {
        "id": "jkl012m3-45no-67pq-rstu-012345678jkl",
        "name": "Restaurante Bom 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": "João Santos",
        "email": "joao.santos@example.com",
        "phone": null,
        "born_date": null
      },
      "company": {
        "id": "vwx234y5-67za-89bc-defg-234567890vwx",
        "name": "Loja de Eletrônicos Tech"
      }
    }
  ]
}

Estrutura da Resposta

Campo	Tipo	Descrição
total	integer	Total de registros disponíveis
limit	integer	Limite por página
offset	integer	Offset atual
data	array	Lista de premiados

Estrutura do Premiado

Campo	Tipo	Descrição
id	string	ID único do registro
created_at	string	Data de criação
awarded.id	string	ID do prêmio
awarded.name	string	Nome do prêmio
client.id	string	ID do cliente
client.name	string	Nome do cliente
client.email	string	Email do cliente
client.phone	string	Telefone do cliente
client.born_date	string	Data de nascimento
company.id	string	ID da empresa
company.name	string	Nome da empresa

Códigos de Resposta

Código	Descrição
200	Premiados encontrados
403	Token inválido ou usuário não autorizado
404	Token de integração não encontrado