Esse serviço tem como objetivo o vínculo dos clientes na carteira do vendedor, permitindo a visualização dos clientes no smartforce.
Início > Carteira de Clientes
Versão: 2.0
Carteira de Clientes
Última Atualização: 15/05/2024
Parâmetros da requisição
porPagina: Integer. Limite de 500 por requisição.
Ex: 100
pagina: Integer.
Ex: 1
codVendedor: String.
Ex: 123-A
emailVendedor: String.
cnpjCliente: String.
Ex: 12345678000199
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
data
Tipo: Array.
cod_vendedor
Código do vendedor.
Tipo: String
nome
Nomo do vendedor.
Tipo: String.
Email do vendedor.
Tipo: String.
cnpj_cliente
Cnpj do cliente.
Tipo: String.
total
Total de usuários dentro de "data"
Tipo: Array.
data_inicio
Data de inicio da carteira.
Tipo: String.
data_fim
Data final da carteira.
Tipo: String.
vendedor_principal
Verificador de vendedor principal do cliente: "Sim" ou "Não".
Tipo: String.
GET Carteira de Clientes
Última Atualização: 29/05/2025
Endpoint responsável por buscar carteiras de clientes cadastradas para o fornecedor.
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
cod_vendedor *
Código do vendedor.
Tipo: String.
cnpj_cliente *
CNPJ do cliente
Tipo: Datetime.
data_inicio *
Data início da inclusão do cliente na carteira.
Tipo: String.
data_fim *
Data fim da vigência do cliente na carteira.
Tipo: String.
vendedor_principal
Tipo: String.
Indica se o vendedor é o principal.
Obs: Caso seja o único vendedor do cliente, é ideal que seja informado "Sim". Caso tenha mais de um vendedor, informar "Sim" pra um e "Não" para os demais.
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
data
Tipo: Array.
id
Id do usuário
Tipo: Integer
razao_social
Razão social do usuário
Tipo: String.
nome
Nome do usuário
Tipo: String.
cnpj
CNPJ do usuário
Tipo: String.
total
Total de usuários dentro de "data"
Tipo: Array.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
POST Carteira de Clientes
Última Atualização: 15/05/2024
Endpoint responsável pelo cadastro da carteira de clientes do vendedor.
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
cod_vendedor
Código do vendedor.
Tipo: String.
cnpj_cliente
CNPJ do cliente
Tipo: Datetime.
data_inicio
Data em que o cliente foi colocado na carteira de clientes do vendedor
Tipo: String.
data_fim
Data em que o cliente não estará mais na carteira de clientes do vendedor
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
id
ID da carteira de clientes que for editada
Tipo: Integer.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
vendedor_principal
Indica se o vendedor é o principal.
Obs: Caso seja o único vendedor do cliente, é ideal que seja informado "Sim". Caso tenha mais de um vendedor, informar "Sim" pra um e "Não" para os demais.
Tipo: String.
PUT Carteira de Clientes
Última Atualização: 15/05/2024
Endpoint responsável pela atualização da carteira de clientes do vendedor..
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
cod_vendedor
Código do vendedor.
Tipo: String.
cnpj_cliente
CNPJ do cliente
Tipo: Datetime.
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
id
ID da carteira de clientes que for apagada.
Tipo: Integer.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
DELETE Carteira de Clientes
Última Atualização: 15/05/2024
Endpoint responsável pela remoção do cliente na carteira do vendedor.