Consultar
Utilizado para verificar os dados do consumidor pertinentes ao programa de Fidelidade, como: nome, saldo de pontos atuais e prêmios que ele pode resgatar com o saldo atual
postConsultarConsumidor
post
https://api.fidelimax.com.br/api/Integracao/ConsultaConsumidor
Exemplo em POSTMAN - https://bit.ly/3eO6Q6N
Request
Response
Request
Path Parameters
AuthToken
optional
string
Token de integração que está na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar.
Body Parameters
cpf
required
string
CPF do Consumidor. Campo obrigatório se os demais campos não forem enviados
cartao
required
string
Cartão que pode ser vinculado ao consumidor. Campo obrigatório se os demais campos não forem enviados
telefone
required
string
Telefone do Consumidor, formato (11)99999-9999. Campo obrigatório se os demais campos não forem enviados
Response
200: OK
consumidor_existente - Consumidor existe no programa de fidelidade
saldo - Saldo em pontos do consumidor
pontos_expirar - Pontos a expirar nos próximos 30 dias
CodigoResposta - Identificação numérica da resposta
MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK
produtos - Array de objetos contendo informações dos prêmios que o consumidor tem saldo suficiente para resgatar
produtos.nome - Nome do prêmio
produtos.descricao - Descrição detalhada do prêmio
produtos.foto - Url em que a foto do prêmio está armazenada
produtos.identificador - Identificador vinculado ao prêmio
produtos.pontos - Pontos necessários para resgatar o prêmio
{"consumidor_existente": true,"saldo": 200,"pontos_expirar": 5,"produtos": [{"nome": "Prêmio 1","descricao": "Prêmio nos tamanhos P, M e G","foto": "http://url.com.br","identificador": "PremioXXX","pontos": 80}],"CodigoResposta": 100,"MensagemErro": ""}
Last updated 7 months ago