Listar recompensas conquistadas no estabelecimento
Efetue a busca de qualquer recompensa conquistada por um determinado cliente no estabelecimento.
bash
curl --location --request GET 'https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/99999/recompensas' \
--header 'app-token: {{app-token}}' \
--header 'access-token: {{access-token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \Este endpoint poderá contemplar os seguintes parâmetros GET, facilitando a busca de qualquer recompensa dependendo do tipo de operação que estiver realizando:
| Parâmetro | Descrição | Exemplo |
|---|---|---|
| filtrar_por | Especificação do campo usado no filtro por data. Valores aceitos: valido_ate, data_resgate, data_conquista, estornado_em | data_conquista |
| status | Status do prêmio a ser filtrado. Valores aceitos: expirado, pendente_resgate, resgatado, estornado | resgatado |
| categoria | Categoria do prêmio a ser filtrado. Valores aceitos: premio_fidelidade, brinde_roleta, premio_campanha, premio_surpresa, premio_game | premio_fidelidade |
| data_inicio | Data de início do período filtrado. Formato: YYYY-MM-DD. | 2024-01-01 |
| data_fim | Data de fim do período filtrado. Formato: YYYY-MM-DD. | 2024-12-31 |
| q | Buscar pelo nome de qualquer premiação. | Coca-Cola |
| itens_por_pagina | Quantidade de registros por página. | 50 |
| id_cliente | ID do cliente no qual deseja filtrar. | 123456 |
No retorno deverá conter:
json
{
"success": true,
"message": "Recompensas retornadas com sucesso",
"data": {
"current_page": 1,
"data": [
{
"id_premio_cliente": 111111,
"id_cliente": 1111111,
"id_premio": 1111111,
"valido_ate": "2025-01-01 00:00:00",
"data_resgate": null,
"data_conquista": "2025-01-01 00:00:00",
"estornado_em": null,
"premio_status": "resgatado",
"categoria_premio": "premio_fidelidade",
"nome": "Coca cola"
}
],
"first_page_url": "http://sandbox.fidelizii.com.br/api/v4/estabelecimentos/999999/recompensas?page=1",
"from": 1,
"last_page": 6,
"last_page_url": "http://sandbox.fidelizii.com.br/api/v4/estabelecimentos/999999/recompensas?page=6",
"next_page_url": "http://sandbox.fidelizii.com.br/api/v4/estabelecimentos/999999/recompensas?page=2",
"per_page": 1,
"prev_page_url": null,
"to": 1,
"total": 6
}
}