Listar Clientes

Utilizado para retornar todos os consumidores que estão cadastrados no programa de fidelidade

post
ListarConsumidores

https://api.fidelimax.com.br/api/Integracao/ListarConsumidores
Exemplo em POSTMAN - https://bit.ly/31Aje6Y
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
novos
optional
boolean
Retorna mais recentes consumidores cadastrados no programa de fidelidade
skip
optional
integer
Quantidade de registros para pular
take
optional
integer
Quantidade de registros para retornar, quantidade máxima são 50 registros
Response
200: OK
total - Quantidade total de consumidores cadastrados no programa de fidelidade CodigoResposta - Identificação numérica da resposta MensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OK consumidores - Array de objetos contendo as informações dos consumidores consumidores.nome - Nome do consumidor consumidores.sexo - Sexo do consumidor consumidores.data_nascimento - Data de nascimento do consumidor consumidores.email - E-mail do consumidor consumidores.telefone - Telefone do consumidor consumidores.pontuacoes - Array de objetos contendo o saldo dos consumidores por franquia/loja consumidores.pontuacoes.saldo - Saldo do consumidor na loja consumidores.pontuacoes.loja - Nome da loja
{
"total": 1,
"consumidores": [
{
"nome": "Nome Consumidor",
"sexo": "Masculino",
"data_nascimento": "26/01/1999",
"email": "email@dominio.com.br",
"pontuacoes" : [
{
"saldo": 20,
"loja": "Loja 1"
},
{
"saldo": 5,
"loja": "Loja 2"
}
],
},
],
"CodigoResposta": 100,
"MensagemErro": ""
}