Início > Consultor
Versão: 2.0
Consultor
Última Atualização: 15/04/2024
Está integração tem o papel de gerenciar informações dos consultores/vendedores dos fornecedores. Nela os consultores podem ser listados, cadastrados, atualizados ou deletados.
Parâmetros da requisição
email: String.
Obs: Este atributo é opcional para busca de um determinado consultor.
pagina*: Integer.
Ex: 1.
Obs: Inicia na página 1.
por_pagina*: Integer.
Ex: 20
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
mensagem
Mensagem de sucesso ou falha da requisição.
Tipo: String.
consultores
Dados dos consultores.
Tipo: Lista de JSON.
nome
Nome do consultor.
Tipo: String.
Email do consultor.
Tipo: String.
deletado
Informa se o consultor está ativo ou foi deletado.
Tipo: Boolean.
cpf
CPF do consultor.
Tipo: String.
cod_vendedor
Código do consultor.
Tipo: String.
telefone
Telefone do consultor.
Tipo: String.
Whatsapp do consultor.
Tipo: String.
paginacao
Dados da paginação da consulta.
Tipo: JSON.
pagina
Indica qual página foi retornada.
Tipo: Integer.
por_pagina
Indica a quantidade de itens exibido por página.
Tipo: Integer.
total_paginas
Quantidade total de páginas retornadas.
Tipo: Integer.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Caso não sejam fornecidos os atributos obrigatórios pagina e por_pagina.
Caso ocorra algum dos erros abaixo, entre em contato conosco.
404 Not Found
500 Not Found
GET Consultor
Última Atualização: 15/04/2024
Este endpoint irá listar consultores do fornecedor cadastrados na base de dados da Yandeh.
Endpoint GET
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
nome *
Nome do consultor.
Tipo: String.
email *
Email do consultor que será atualizado.
Tipo: String.
cpf
Cpf do consultor.
Tipo: String.
cod_vendedor *
Código do consultor.
Tipo: String.
telefone
Telefone do consultor.
Tipo: String.
Whatsapp do consultor.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
mensagem
Mensagem de sucesso ou falha da requisição.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Caso seja adicionado um consultor já cadastrado:
Caso ocorra algum dos erros abaixo, entre em contato conosco.
404 Not Found
500 Not Found
POST Consultor
Última Atualização: 15/04/2024
Este endpoint irá adicionar novos consultores do fornecedor na plataforma.
Endpoint POST
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
nome
Nome do consultor.
Tipo: String.
email *
Email do consultor que será atualizado.
Tipo: String.
cpf
Cpf do consultor.
Tipo: String.
cod_vendedor
Código do consultor.
Tipo: String.
telefone
Telefone do consultor.
Tipo: String.
Whatsapp do consultor.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
mensagem
Mensagem de sucesso ou falha da requisição.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
404 Not Found
Caso seja informado um e-mail invalido:
Caso ocorra algum dos erros abaixo, entre em contato conosco.
404 Not Found
500 Not Found
PUT Consultor
Última Atualização: 15/04/2024
Este endpoint atualiza informações de um consultor especifico na plataforma.
Para isso, é necessário fornecer o email, que é único para cada fornecedor.
Endpoint PUT
Sintaxe da Requisição
Para que a requisição do método Delete seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
email *
Email do consultor que será deletado.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhes da requisição.
Tipo: JSON.
success
Identificador booleano de sucesso da requisição.
Tipo: Boolean.
mensagem
Mensagem de sucesso ou falha da requisição.
Tipo: String.
Respostas para erros
Caso ocorra algum dos erros abaixo, entre em contato conosco.
404 Not Found
500 Not Found
DELETE Consultor
Última Atualização: 15/04/2024
Este endpoint irá remover consultores do fornecedor de acordo com o e-mail informado.