API de demandante: vendedores

Este artículo es parte de la documentación API de integración REST.

Documentación para consultar, insertar, actualizar y eliminar vendedores.

Consulta

Enumere los vendedores de la empresa. Sin filtro, considera dataAlteracao de los últimos 6 meses.

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

Precaución

Paginación

• pagina — base 1 (predeterminado 1)
• limite — predeterminado 100, máximo 500

Filtros

• Formato filtroDataAlteracao — Y-m-d
• operadorFiltro (opcional) — <, >, =, <=, >= (predeterminado >=)

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"
    }
  ]
}

Insertar o actualizar

POST inserción mediante la tecla codigo.

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

Propiedad	Tipo	Tamaño	Obligatorio	Descripción
código	entero		✓	Código de vendedor. Identificador único utilizado para insertar o actualizar (upsert).
nombre	cadena	100	✓	Nombre del vendedor.
correo electrónico	cadena	255	✓	Correo electrónico/inicio de sesión del vendedor. Debe ser único.
codTipoUsuario	entero		✓	Valores: 1 (Vendedor) o 2 (Gerente de Ventas).
numPedidoInicial	entero		✓	Inicio del rango de pedidos del vendedor.
numPedidoFinal	entero		✓	Fin del rango de pedidos del vendedor.
numPedidoAtual	entero			Orden actual (opcional). Si se omite en la inclusión, se supone numPedidoInicial. Si se informa, debe estar dentro del alcance.
activo	entero			Valores: 0 o 1. Valor predeterminado de inclusión: 1.
IMEI	cadena	50		Identificador del dispositivo. Si se le informa, restrinja el inicio de sesión a IMEI.
emailSecundario	cadena	255		Correo electrónico secundario para comunicación.
listasDePreco	cadena			Códigos de lista de precios separados por comas. Por ejemplo: 3,4,9.
gruposProduto	cadena			Códigos de grupo de productos separados por comas.
ocultarGruposDeProduto	entero			Valores: 0 (mostrar) o 1 (ocultar) los grupos informados.
saldoFlex	decimal			Saldo flexible del vendedor en el ERP.
senhaAtual	cadena	255		Al incluirlo, puede establecer la contraseña si no se envía senhaNova. Al actualizar se debe enviar junto con senhaNova y consultar con la contraseña actual.
senhaNova	cadena	255		Nueva contraseña (mínimo 6 caracteres). Inclusión preferencial. No se devuelve en la respuesta.
segmentosRelacionados	cadena	500		Códigos de segmento vinculados al vendedor.
sucursales	cadena			Códigos de sucursal publicados, separados por comas.
codVendedorPai	entero			Código del vendedor matriz (agente).
codHierarquiaLiberacaoPedido	cadena	255		Código de jerarquía de liberación de pedidos.
saldoFlexAcumulado	decimal			Saldo flexible acumulado del vendedor.
permiteCadastroCliente	entero			Valores: 0 o 1.
permiteEdicaoCliente	entero			Valores: 0 o 1.
permiteCadastroDeFotoDeProduto	entero			Valores: 0 o 1.
permiteAdicionarRota	entero			Valores: 0 o 1.
permiteControlarRota	entero			Valores: 0 o 1.
permiteAdicionarRotaClientes	entero			Valores: 0 o 1.
permiteControlarRotaClientes	entero			Valores: 0 o 1.
capturarPosGeoNoPedido	entero			Valores: 0 o 1.
exigeCapturaGPSEventos	entero			Valores: 0 o 1.
exigeFotoEventos	entero			Valores: 0 o 1.
exigeCheckinCheckout	entero			Valores: 0 o 1.
checkinRaio	entero			Radio de entrada en metros.
checkinDias	entero			Número de días para el check-in.
permiteVisualizarResumoVendas	entero			Valores: 0 o 1.
exigeCheckout	entero			Valores: 0 o 1.
permiteRegistroCobranca	entero			Valores: 0 o 1.
valorMinimoPedido	decimal			Valor mínimo permitido para emitir un pedido.
regraPedidoClienteOutroVendedor	cadena	30		Valores: CONFORME_CONFIG_EMPRESA, SOMENTE_ATIVOS, ATIVOS_INATIVOS, SOMENTE_INATIVOS, NUNCA. Predeterminado: CONFORME_CONFIG_EMPRESA.
tiposPedidoLiberados	cadena	100		Códigos de tipo de pedido separados por comas.
comportamentoSaldoFlex	entero			Valores: 0 (según empresa), 1 (habilitado), 2 (deshabilitado). Predeterminado: 0.
teléfono	cadena	40		Número de teléfono del vendedor. Vacío no actualiza el valor ya registrado.
saldoBonificacaoERP	decimal			Saldo de bonificación en ERP.
observacaoSaldoBonificacao	cadena	2000		Observación del saldo de bonificación.

Precaución

Inclusión

• Es necesario enviar todos los atributos que sean obligatorios. Devolver 201.

Actualización

• Sólo el atributo codigo es obligatorio. Devuelve 200.

Contraseña

• Tras la inclusión, envíe senhaNova (o senhaAtual) para establecer la contraseña.
• Al actualizar, envíe senhaAtual y senhaNova juntos. Si la contraseña actual no coincide, la contraseña no se cambia.
• La contraseña nunca se devuelve en la respuesta.Rango de pedido
• numPedidoInicial debe ser menor que numPedidoFinal.
• numPedidoAtual es opcional; si se envía, debe estar dentro del alcance.

Actualización parcial

• Varios campos opcionales solo se guardan cuando se envían con un valor completo (vacío no borra el registro).
• Ejemplos: IMEI, listasDePreco, telefone, saldoFlex, permisos permite*/exige*.

Cuerpo:

{
  "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"
}

Eliminar

Eliminar al vendedor.

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

Retorno:

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