Skip to content

Cadastrar um novo cliente no programa de fidelidade

Efetuar o cadastro de um novo cliente no programa de fidelidade em um estabelecimento

bash
curl --location 'https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/99999/clientes/cadastrar' \
--header 'app-token: {{app-token}}' \
--header 'access-token: {{access-token}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "celular": "+551999516237",
    "cpf": "99667942988",
    "nome": "Elena Kuhlman",
    "email": "teste@teste.com.br",
    "data_nascimento": "1994-04-01",
    "genero": "M",
    "cep": "444444",
    "endereco": "",
    "bairro": "",
    "cidade": "",
    "estado": ""
}'

No payload enviado, deverá conter:

ParâmetroDescriçãoExemplo
celularCelular do cliente (Obrigatório, formato E.164)+551999999999
cpfCPF do cliente (Opcional — se não informado, gerar hash aleatório)44444444444
nomeNome completo do cliente (Opcional — se ausente, usar "CLIENTE DESCONHECIDO")TESTE INTERNO
emailE-mail do cliente (Opcional — se ausente, usar "invalido@invalido.com.br")teste@teste.com.br
data_nascimentoData de nascimento (Opcional — formato YYYY-MM-DD)1994-01-01
generoGênero do cliente (Opcional — M: Masculino, F: Feminino)M
cepCEP do cliente (Opcional — apenas números)444444
enderecoEndereço do cliente (Opcional — máximo 100 caracteres)Rua Exemplo, 123
bairroBairro do cliente (Opcional — máximo 50 caracteres)Centro
cidadeCidade do cliente (Opcional)Campinas
estadoEstado do cliente (Opcional — preferencialmente sigla UF)SP

Cadastro + Pontuação em uma única requisição

O endpoint de pontuação do cliente, já contempla a mecânica de cadastro de clientes também, caso queira otimizar a requisção do lado da sua aplicação, basta realizar apenas uma chamada ao endpoint de pontuar.

No retorno deverá conter:

json
{
    "success": true,
    "message": "Cliente criado com sucesso.",
    "data": {
        "id_cliente": 1111111,
        "nome": "NOME DO CLIENTE",
        "email": "INVALIDO@INVALIDO.COM.BR",
        "data_cadastro": "2025-01-01 00:00:00",
        "celular": "+551999516237",
        "data_nascimento": "1990-01-01",
        "genero": "m",
        "cep": null,
        "endereco": null,
        "bairro": null,
        "cidade": null,
        "uf": null,
        "carteira": {
            "saldo": 0,
            "saldo_carencia": 0,
            "pontos_vencidos": [],
            "pontos_vencendo": []
        },
        "receita": 0,
        "compras": 0,
        "primeira_compra": null,
        "ultima_compra": null,
        "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
    }
}