Listar Clientes

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

ListarConsumidores

POST https://api.fidelimax.com.br/api/Integracao/ListarConsumidores

Exemplo no POSTMAN - https://www.postman.com/fidelimax/workspace/fidelimax-api-1-0/request/18773698-7cf7d13a-32ae-477f-9cea-538c1368c3b8

Headers

Name	Type	Description
AuthToken*	string	Token de integração que esta na sua plataforma de controle em Integrações > API da Fidelimax > Quero Integrar.
Content-Type*	String	application/json

Request Body

Name	Type	Description
novos*	boolean	Retorna mais recentes consumidores cadastrados no programa de fidelidade
skip *	integer	Quantidade de registros para pular
take*	integer	Quantidade de registros para retornar, quantidade máxima são 50 registros

200 total - Quantidade total de consumidores cadastrados no programa de fidelidadeCodigoResposta - Identificação numérica da respostaMensagemErro - Mensagem retornada pela API, quando há uma resposta diferente de OKconsumidores - Array de objetos contendo as informações dos consumidoresconsumidores.nome - Nome do consumidorconsumidores.sexo - Sexo do consumidorconsumidores.data_nascimento - Data de nascimento do consumidorconsumidores.email - E-mail do consumidorconsumidores.telefone - Telefone do consumidorconsumidores.pontuacoes - Array de objetos contendo o saldo dos consumidores por franquia/lojaconsumidores.pontuacoes.saldo - Saldo do consumidor na lojaconsumidores.pontuacoes.loja - Nome da loja

{    
    "total": 1,
    "consumidores": [
    {
      "nome": "Nome Consumidor",
      "sexo": "Masculino",
      "data_nascimento": "26/01/1999",
      "email": "[email protected]",
      "pontuacoes" : [
        {
          "saldo": 20,
          "loja": "Loja 1" ,
          "cashback": 1     
        },
        {
          "saldo": 5,
          "loja": "Loja 2",
          "cashback": 2
        }
      ],
    },
    ],
    "CodigoResposta": 100,
    "MensagemErro": ""
}