Início > Pré cadastro de clientes
Versão: 2.0
Pré Cadastro de Clientes
Endpoint responsável pelos clientes pré-cadastrados nos aplicativos SmartForce e SmartSales para posterior cadastro no ERP do fornecedor.
GET Clientes Pré-Cadastrados
Endpoint responsável por retornar os clientes pré-cadastrados nos aplicativos Yandeh.
Endpoint GET
URL:
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos usuários.
status: Status do cadastro.
-
Status permitidos: Novo, Processando, Rejeitado e Finalizado.
-
Parâmetro não obrigatório.
Exemplo:
curl --location 'https://yandeh-seller-integration.yandeh.com.br/cliente/smartforce?status=Novo' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Clientes listados com sucesso."
},
"data": [
{
"id": 165,
"cnpj": "59828002000140",
"razao_social": "Mercado da Silva",
"nome_fantasia": "Silva Minimercado",
"ramo_atividade": "MERCADINHO/MERCEARIA/ACOUGUE",
"data_fundacao": "2024-02-15",
"cep": "06000170",
"endereco": "Rua José Silva",
"numero": "200",
"complemento": "mercado de esquina",
"bairro": "Parque Sul",
"cidade": "São Paulo",
"uf": "SP",
"contato": "João",
"telefone_1": "11999731499",
"email_nfe_1": "mercadosilva@gmail.com",
"email_nfe_2": "joao@gmail.com",
"email_comercial": "",
"email_cobranca": "",
"obs_nota": "",
"observacao": "Contato direto com o proprietário",
"data_avaliacao": null,
"motivo": null,
"status": "Novo",
"whatsapp": "119900932000",
"aceite_lgpd": true,
"aceite_lgpd_nome": "João da Silva",
"aceite_lgpd_cpf": "40800915000",
"inscricao_estadual": "35000883744",
"visita_dia": "Segunda-feira",
"visita_frequencia": "Semanalmente",
"vendedor": {
"id": 19000,
"email": "joaquim@hotmail.com",
"codVendedor": "AB123"
}
}
]
}
Elementos da Resposta
detail: Detalhes da requisição.
success: Status da requisição.
Tipo: Boolean.
message: Mensagem do status da requisição.
Tipo: String.
data: Lista dos clientes.
Tipo: Array de json.
id: Identificador (ID) do cliente na requisição.
Tipo: Integer.
cnpj: CNPJ da empresa.
Tipo: String.
razao_social: Razão social da empresa.
Tipo: String.
nome_fantasia: Nome fantasia da empresa.
Tipo: String.
ramo_atividade: Ramo de atividade (Cluster)
Tipo: String.
data_fundacao : Data de fundação da empresa.
Tipo: String.
cep: CEP do estabelecimento onde a empresa está localizada.
Tipo: String.
endereco: Nome do logradouro onde a empresa está localizada.
Tipo: String.
numero: Número do estabelecimento onde a empresa está localizada.
Tipo: String.
complemento: Complemento do endereço.
Tipo: String.
bairro: Bairro onde o estabelecimento da empresa está localizado.
Tipo: String.
cidade: Cidade onde o estabelecimento da empresa está localizado.
Tipo: String.
uf: Estado onde o estabelecimento da empresa está localizado.
Tipo: String.
contato: Informações de contato do cliente.
Tipo: String.
telefone_1: Telefone para contato do cliente.
Tipo: String.
email_nfe_1: E-mail destinado ao envio e emissão de notas fiscais.
Tipo: String.
email_nfe_2: E-mail secundário destinado ao envio e emissão de notas fiscais.
Tipo: String.
email_comercial: E-mail destinado a assuntos comerciais.
Tipo: String.
email_cobranca: E-mail destinado a assuntos de cobranças.
Tipo: String.
obs_nota: Observações destinadas a emissão de notas fiscais.
Tipo: String.
observacao: Observações gerais.
Tipo: String.
data_avaliacao: Data de avaliação do cadastro do cliente.
Tipo: String.
motivo: Motivo do status.
Tipo: String.
status: Status do cadastro do cliente.
Tipo: String.
whatsapp: Whatsapp para contato do cliente.
Tipo: String.
aceite_lgpd: Indica se o cliente aceitou os termos da Lei Geral de Proteção de Dados (LGPD).
Tipo: Booleano.
aceite_lgpd_nome: Nome do responsável pelo aceite da LGPD.
Tipo: String.
aceite_lgpd_cpf: CPF do responsável pelo aceite da LGPD.
Tipo: String.
inscricao_estadual: Inscrição estadual da empresa.
Tipo: String.
visita_dia: Data programada da visita do vendedor ao cliente.
Tipo: String.
visita_frequencia: Frequência da visita do vendedor ao cliente
Tipo: String.
vendedor: Informações do vendedor responsável pelo cliente.
Tipo: Array de json.
id: Identificador(ID) do vendedor na Yandeh.
Tipo: String.
email: E-mail do vendedor.
Tipo: String.
codVendedor: Código interno que identifica o vendedor no ERP do fornecedor.
Tipo: String.
PATCH Clientes Pré-Cadastrados
Endpoint responsável por atualizar o status dos clientes pré-cadastrados nos aplicativos Yandeh.
Endpoint PATCH
URL:
Sintaxe da Requisição
-
Tipo de requisição: PATCH.
-
URL: O parâmetro {id_cliente} representa o identificador (ID) do cliente na requisição de pré-cadastro.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
{
"status": "Finalizado",
"reason": "Cliente cadastrado no ERP com sucesso"
}
Exemplo
curl --location --request PATCH 'https://yandeh-seller-integration.yandeh.com.br/cliente/smartforce/20258' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '{
"status": "Finalizado",
"reason": "Cliente cadastrado no ERP com sucesso"
}'
Elementos da Requisição
status: Status do cadastro.
-
Status permitidos: Processando, Rejeitado e Finalizado
-
Campo obrigatório
Tipo: String.
reason: Justificativa do status.
-
Campo não obrigatório.
Tipo: String.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"detail": {
"success": true,
"message": "Cliente 123 atualizado com sucesso"
}
}
Resposta para Erros
422 Validation Error - O status enviado é igual ao status atual.
{
"detail": {
"success": false,
"message": "Erro ao atualizar cliente no SmartForce"
},
"data": "Cliente 102 já possui o status Finalizado"
}
422 Validation Error - Cliente não encontrado
{
"detail": {
"success": false,
"message": "Cliente não encontrado no SmartForce"
},
"data": {}
}