API do Demander - Vendedores

Este artigo faz parte da documentação da API de Integração REST.

Documentação para consultar, inserir, atualizar e excluir vendedores.

Consulta

Lista os vendedores da empresa. Sem filtro, considera dataAlteracao dos últimos 6 meses.

Rota: {host}/public/v1/vendedores?pagina={pagina}&limite={limite}&filtroDataAlteracao={data}&operadorFiltro={operador}
Método: GET

Cuidado

Paginação

• pagina — base 1 (padrão 1)
• limite — padrão 100, máximo 500

Filtros

• filtroDataAlteracao — formato Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (padrão >=)

Retorno:

{
  "vendedores": [
    {
      "codigo": 25,
      "nome": "THOMAS",
      "IMEI": null,
      "email": "email@site.com.br",
      "emailSecundario": null,
      "codTipoUsuario": 1,
      "numPedidoAtual": 754120,
      "numPedidoInicial": 750000,
      "numPedidoFinal": 800000,
      "ativo": 1,
      "listasDePreco": "3,4,9",
      "gruposProduto": null,
      "ocultarGruposDeProduto": null,
      "saldoFlex": null,
      "segmentosRelacionados": null,
      "filiais": null,
      "codVendedorPai": null,
      "codHierarquiaLiberacaoPedido": null,
      "saldoFlexAcumulado": null,
      "permiteCadastroCliente": 1,
      "permiteEdicaoCliente": 1,
      "permiteCadastroDeFotoDeProduto": null,
      "permiteAdicionarRota": null,
      "permiteControlarRota": null,
      "permiteAdicionarRotaClientes": null,
      "permiteControlarRotaClientes": null,
      "capturarPosGeoNoPedido": null,
      "exigeCapturaGPSEventos": null,
      "exigeFotoEventos": null,
      "exigeCheckinCheckout": null,
      "checkinRaio": 0,
      "checkinDias": 0,
      "permiteVisualizarResumoVendas": null,
      "exigeCheckout": null,
      "permiteRegistroCobranca": 0,
      "valorMinimoPedido": null,
      "regraPedidoClienteOutroVendedor": "CONFORME_CONFIG_EMPRESA",
      "tiposPedidoLiberados": null,
      "comportamentoSaldoFlex": 0,
      "telefone": null,
      "saldoBonificacaoERP": "0.00",
      "observacaoSaldoBonificacao": null,
      "dataAlteracao": "2026-07-24 10:00:00"
    }
  ]
}

Inserir ou atualizar

POST upsert pela chave codigo.

Rota: {host}/public/v1/vendedores
Método: POST
Body: json

Propriedade	Tipo	Tamanho	Obrigatório	Descrição
codigo	int		✓	Código do vendedor. Identificador único usado para inserir ou atualizar (upsert).
nome	string	100	✓	Nome do vendedor.
email	string	255	✓	E-mail/login do vendedor. Deve ser único.
codTipoUsuario	int		✓	Valores: 1 (Vendedor) ou 2 (Gerente de Vendas).
numPedidoInicial	int		✓	Início da faixa de pedido do vendedor.
numPedidoFinal	int		✓	Fim da faixa de pedido do vendedor.
numPedidoAtual	int			Pedido atual (opcional). Se omitido na inclusão, assume numPedidoInicial. Se informado, deve estar dentro da faixa.
ativo	int			Valores: 0 ou 1. Padrão na inclusão: 1.
IMEI	string	50		Identificador do aparelho. Se informado, restringe o login ao IMEI.
emailSecundario	string	255		E-mail secundário para comunicação.
listasDePreco	string			Códigos das listas de preço separados por vírgula. Ex.: 3,4,9.
gruposProduto	string			Códigos dos grupos de produto separados por vírgula.
ocultarGruposDeProduto	int			Valores: 0 (exibir) ou 1 (ocultar) os grupos informados.
saldoFlex	decimal			Saldo flex do vendedor no ERP.
senhaAtual	string	255		Na inclusão, pode definir a senha se senhaNova não for enviada. Na atualização, deve ser enviada junto com senhaNova e conferir com a senha atual.
senhaNova	string	255		Nova senha (mínimo 6 caracteres). Preferencial na inclusão. Não é retornada na resposta.
segmentosRelacionados	string	500		Códigos dos segmentos vinculados ao vendedor.
filiais	string			Códigos das filiais liberadas, separados por vírgula.
codVendedorPai	int			Código do vendedor pai (preposto).
codHierarquiaLiberacaoPedido	string	255		Código da hierarquia de liberação do pedido.
saldoFlexAcumulado	decimal			Saldo flex acumulado do vendedor.
permiteCadastroCliente	int			Valores: 0 ou 1.
permiteEdicaoCliente	int			Valores: 0 ou 1.
permiteCadastroDeFotoDeProduto	int			Valores: 0 ou 1.
permiteAdicionarRota	int			Valores: 0 ou 1.
permiteControlarRota	int			Valores: 0 ou 1.
permiteAdicionarRotaClientes	int			Valores: 0 ou 1.
permiteControlarRotaClientes	int			Valores: 0 ou 1.
capturarPosGeoNoPedido	int			Valores: 0 ou 1.
exigeCapturaGPSEventos	int			Valores: 0 ou 1.
exigeFotoEventos	int			Valores: 0 ou 1.
exigeCheckinCheckout	int			Valores: 0 ou 1.
checkinRaio	int			Raio para check-in em metros.
checkinDias	int			Quantidade de dias para check-in.
permiteVisualizarResumoVendas	int			Valores: 0 ou 1.
exigeCheckout	int			Valores: 0 ou 1.
permiteRegistroCobranca	int			Valores: 0 ou 1.
valorMinimoPedido	decimal			Valor mínimo permitido para emissão de pedido.
regraPedidoClienteOutroVendedor	string	30		Valores: CONFORME_CONFIG_EMPRESA, SOMENTE_ATIVOS, ATIVOS_INATIVOS, SOMENTE_INATIVOS, NUNCA. Padrão: CONFORME_CONFIG_EMPRESA.
tiposPedidoLiberados	string	100		Códigos dos tipos de pedido separados por vírgula.
comportamentoSaldoFlex	int			Valores: 0 (conforme empresa), 1 (habilitado), 2 (desabilitado). Padrão: 0.
telefone	string	40		Telefone do vendedor. Vazio não atualiza o valor já cadastrado.
saldoBonificacaoERP	decimal			Saldo de bonificação no ERP.
observacaoSaldoBonificacao	string	2000		Observação do saldo de bonificação.

Cuidado

Inclusão

• É necessário enviar todos os atributos que são obrigatórios. Retorno 201.

Atualização

• Apenas o atributo codigo é obrigatório. Retorno 200.

Senha

• Na inclusão, envie senhaNova (ou senhaAtual) para definir a senha.
• Na atualização, envie senhaAtual e senhaNova juntos. Se a senha atual não conferir, a senha não é alterada.
• A senha nunca é retornada na resposta.

Faixa de pedido

• numPedidoInicial deve ser menor que numPedidoFinal.
• numPedidoAtual é opcional; se enviado, deve estar dentro da faixa.

Atualização parcial

• Vários campos opcionais só são gravados quando enviados com valor preenchido (vazio não limpa o cadastro).
• Exemplos: IMEI, listasDePreco, telefone, saldoFlex, permissões permite*/exige*.

Body:

{
  "codigo": 25,
  "nome": "THOMAS",
  "email": "email@site.com.br",
  "codTipoUsuario": 1,
  "numPedidoInicial": 750000,
  "numPedidoFinal": 800000,
  "numPedidoAtual": 754120,
  "ativo": 1,
  "listasDePreco": "3,4,9",
  "senhaNova": "senha12"
}

Retorno:

{
  "codigo": 25,
  "nome": "THOMAS",
  "IMEI": null,
  "email": "email@site.com.br",
  "emailSecundario": null,
  "codTipoUsuario": 1,
  "numPedidoAtual": 754120,
  "numPedidoInicial": 750000,
  "numPedidoFinal": 800000,
  "ativo": 1,
  "listasDePreco": "3,4,9",
  "gruposProduto": null,
  "ocultarGruposDeProduto": null,
  "saldoFlex": null,
  "segmentosRelacionados": null,
  "filiais": null,
  "codVendedorPai": null,
  "codHierarquiaLiberacaoPedido": null,
  "saldoFlexAcumulado": null,
  "permiteCadastroCliente": null,
  "permiteEdicaoCliente": null,
  "permiteCadastroDeFotoDeProduto": null,
  "permiteAdicionarRota": null,
  "permiteControlarRota": null,
  "permiteAdicionarRotaClientes": null,
  "permiteControlarRotaClientes": null,
  "capturarPosGeoNoPedido": null,
  "exigeCapturaGPSEventos": null,
  "exigeFotoEventos": null,
  "exigeCheckinCheckout": null,
  "checkinRaio": 0,
  "checkinDias": 0,
  "permiteVisualizarResumoVendas": null,
  "exigeCheckout": null,
  "permiteRegistroCobranca": 0,
  "valorMinimoPedido": null,
  "regraPedidoClienteOutroVendedor": "CONFORME_CONFIG_EMPRESA",
  "tiposPedidoLiberados": null,
  "comportamentoSaldoFlex": 0,
  "telefone": null,
  "saldoBonificacaoERP": "0.00",
  "observacaoSaldoBonificacao": null,
  "dataAlteracao": "2026-07-24 10:00:00"
}

Excluir

Remove o vendedor.

Rota: {host}/public/v1/vendedores?codigo={codigo}
Método: DELETE

Retorno:

{
  "mensagem": "Registro excluído com sucesso."
}