👥Clientes

Aqui vamos descrever os principais endpoints sobre clientes da loja no programa de fidelidade

Adicionando um cliente no programa

Para que um cliente consiga fazer resgates ou participar do programa de modo geral, é necessário que ele tenha cadastro dentro do programa.

Você consegue fazer esse cadastro por API.

Adiciona um cliente em um programa de uma determinada loja.

POST https://sandbox.fidelizarmais.com/api/v1/public/client-member

Body Example

{ "type": "painel",

"accountManager": "teste",

"document": "12345678900",

"storeId": "{{_storeId}}",

"firstName": "lara",

"lastName":"ferreira",

"birthdate": "2002-07-01",

"email": "[e-mail]" }

Headers

Name	Type	Description
store-key*	guid	id da loja
secret-key*	guid	chave secreta

Request Body

Name	Type	Description
type*	string	tipo de cadastro, nesse caso é "painel"
storeId*	guid	id da loja
cellphone	string	celular do cliente
email*	string	e-mail do cliente
firstName *	string	primeiro nome do cliente
sex	int	id do gênero do cliente. Os gêneros disponíveis para cadastro estão em Lista de dados > sex
document*	string	CPF/CNPJ do cliente
active*	bool	informa se o cliente está ativo (true) ou não (false)
zipcode	string	cep
state	string	sigla do estado
district	string	bairro
city	string	cidade
number	string	número da residência
complement	string	complemento do endereço
lastName*	string	sobrenome

200: OK

Buscando um cliente por documento

Você pode verificar ou buscar dados de um cliente no programa da loja à partir desse endpoint.

Busca um cliente por CPF/CNPJ

GET https://sandbox.fidelizarmais.com/api/v1/public/client-member

Para encontrar um cliente é obrigatório passar o storeId (id da loja) e o document (CPF/CNPJ) do cliente na QueryString.

Path Parameters

Name	Type	Description
storeId*	guid	id da loja
document*	string	CPF/CNPJ somente números

Headers

Name	Type	Description
store-key*	guid	id da loja
secret-key*	guid	chave secreta

200: OK