Início > Equipe de vendas
Versão: 2.0
Equipe de vendas
Última Atualização: 22/11/2024
Esta integração tem o papel de possibilitar o gerenciamento das equipes de vendas.
Sintaxe da Requisição
Para que a requisição do método Post seja bem-sucedida, é necessário que
seja enviado os seguintes valores dentro de um JSON:
Elementos da Requisição
cod_gerente *
Código do gerente.
Obs: Obrigatório ou null.
Tipo: Integer.
nome_gerente *
Nome do gerente.
Obs: Obrigatório ou null.
Tipo: String.
email_gerente *
Email do gerente.
Obs: Obrigatório ou null.
Tipo: String.
cod_coordenador *
Código do coordenador.
Obs: Obrigatório ou null.
Tipo: Integer.
nome_coordenador *
Nome do coordenador.
Obs: Obrigatório ou null.
Tipo: String.
email_coordenador *
Email do coordenador.
Obs: Obrigatório ou null.
Tipo: String.
cod_supervisor *
Código do coordenador.
Tipo: Integer.
nome_supervisor *
Nome do supervisor.
Obs: Obrigatório ou null.
Tipo: String.
email_supervisor *
Email do supervisor.
Obs: Obrigatório ou null.
Tipo: String.
cod_vendedor *
Código do vendedor.
Tipo: Integer.
nome_vendedor *
Nome do vendedor.
Tipo: String.
email_vendedor *
Email do vendedor.
Tipo: String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 201, essa será a resposta que você receberá:
Elementos da Resposta
message
Mensagem de retorno da requição.
Tipo: Integer.
totalValidas
Total de cadastros validos.
Tipo: Integer.
totalInvalidas
Total de cadastros invalidos.
Tipo: String.
Caso seja enviado duas ou mais equipes de venda, e pelo menos uma tenha erro no envio e uma tenha exito, os erros serão retornados com este status.
207 Multi-status
Elementos da Resposta
message
Mensagem de retorno da requição.
Tipo: Integer.
totalValidas
Total de cadastros validos.
Tipo: Integer.
totalInvalidas
Total de cadastros invalidos.
Tipo: String.
invalidas
Detalhes dos envios invalidos.
Tipo: Lista de JSON.
cod_gerente
Código do gerente.
Tipo: Integer.
nome_gerente
Nome do gerente.
Tipo: String.
email_gerente
Email do gerente.
Tipo: String.
cod_coordenador
Código do coordenador.
Tipo: Integer.
nome_coordenador
Nome do coordenador.
Tipo: String.
email_coordenador
Email do coordenador.
Tipo: String.
cod_supervisor
Código do coordenador.
Tipo: Integer.
nome_supervisor
Nome do supervisor.
Tipo: String.
email_supervisor
Email do supervisor.
Tipo: String.
cod_vendedor
Código do vendedor.
Tipo: Integer.
nome_vendedor
Nome do vendedor.
Tipo: String.
email_vendedor
Email do vendedor.
Tipo: String.
erros
Erros ocorridos no envio.
Tipo: Lista de JSON.
campo
Campos que tiveram erros.
Tipo: String.
erro
Detalhes do erro.
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
400 Bad Request
Caso o corpo da requisição contenha campos inválidas. O array invalidas conterá os detalhes e os erros encontrados.
(O payload de retorno terá os mesmos campos do status 207).
500 Internal Server Error
POST Equipe de vendas
Última Atualização: 22/11/2024
Este endpoint possibilita que equipes de vendas sejam cadastradas. Para a composição da equipe, podem ser cadastrados: gerente, coordenador, supervisor e vendedor.