Skip to content

Retornar informações de um cliente específico

Retonar informações relacionadas a um determinado cliente cadastrado no estabelecimento.

bash
curl --location --request POST 'https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/99999/clientes/buscar' \
--header 'app-token: {{app-token}}' \
--header 'access-token: {{access-token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{    
    "id_cliente": 280117
}'

No payload enviado, você poderá buscar um cliente, não somente através do seu ID, mas também usando qualquer um dos valores abaixo:

ParâmetroDescriçãoExemplo
cpfBuscar um cliente através do CPF (Somente números)44444444444444
celularBuscar um cliente através do Celular (Somente números no padrão E164)+5519999999999
id_clienteBuscar através do id referência do cliente999999

No retorno deverá conter:

json
{
    "success": true,
    "message": "Cliente retornado com sucesso",
    "data": {
        "id_cliente": 3558808,
        "nome": "NOME DO CLIENTE",
        "email": "email@email.com.br",
        "data_cadastro": "2025-05-07 01:58:42",
        "celular": "+5541854148484",
        "data_nascimento": "1990-04-24",
        "genero": "NA",
        "cep": null,
        "endereco": null,
        "bairro": null,
        "cidade": null,
        "uf": null,
        "carteira": {
            "saldo": 2, // saldo atual do cliente
            "saldo_carencia": 0, // caso o programa possua carência de pontos habilitada, será exibida a quantidade de pontos que irá ser contabilizada no dia seguinte
            "pontos_vencidos": [], // array com a lista de pontos vencidos do cliente
            "pontos_vencendo": [ // array com a lista dos próximos vencimentos de pontos do cliente
                {
                    "id_cartela_cliente": 4016927,
                    "pontos": 2,
                    "data": "2025-05-07 01:59:18",
                    "tipo": "credito",
                    "data_validade": "2026-05-31"
                }
            ],
            "historico": [ // Histórico de pontos acumulados ao longo do tempo
                {
                    "id_cartela_cliente": 4016927,
                    "pontos": 2,
                    "data": "2025-05-07 01:59:18",
                    "tipo": "credito",
                    "data_validade": "2026-05-31"
                }
            ]
        },
        "receita": 32,
        "compras": 1,
        "primeira_compra": "2025-05-07 01:59:18",
        "ultima_compra": "2025-05-07 01:59:18",
        "conquistados_premio_fidelidade": 0,
        "conquistados_brinde_roleta": 0,
        "conquistados_premio_surpresa": 0,
        "conquistados_premio_campanha": 0,
        "conquistados_premio_game": 0,
        "pendente_resgate_premio_fidelidade": 0,
        "pendente_resgate_brinde_roleta": 0,
        "pendente_resgate_premio_surpresa": 0,
        "pendente_resgate_premio_campanha": 0,
        "pendente_resgate_premio_game": 0,
        "resgatado_premio_fidelidade": 0,
        "resgatado_brinde_roleta": 0,
        "resgatado_premio_surpresa": 0,
        "resgatado_premio_campanha": 0,
        "resgatado_premio_game": 0,
        "expirado_premio_fidelidade": 0,
        "expirado_brinde_roleta": 0,
        "expirado_premio_surpresa": 0,
        "expirado_premio_campanha": 0,
        "expirado_premio_game": 0
    }
}