Demander API - Sellers

This article is part of the REST Integration API documentation.

Documentation for querying, inserting, updating and deleting sellers.

Consultation

List the company’s salespeople. Without filter, considers dataAlteracao from the last 6 months.

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

Caution

Pagination

• pagina — base 1 (default 1)
• limite — default 100, maximum 500

Filters

• filtroDataAlteracao — Y-m-d format
• operadorFiltro (optional) — <, >, =, <=, >= (default >=)

Return:

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

Insert or update

POST upsert by key codigo.

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

Property	Type	Size	Mandatory	Description
code	int		✓	Seller code. Unique identifier used to insert or update (upsert).
name	string	100	✓	Seller’s name.
email	string	255	✓	Seller’s email/login. It must be unique.
codTipoUsuario	int		✓	Values: 1 (Salesman) or 2 (Sales Manager).
numPedidoInicial	int		✓	Start of seller order range.
numPedidoFinal	int		✓	End of seller order range.
numPedidoAtual	int			Current order (optional). If omitted in the inclusion, assumes numPedidoInicial. If reported, it must be within range.
active	int			Values: 0 or 1. Default on inclusion: 1.
IMEI	string	50		Device identifier. If informed, restrict login to IMEI.
emailSecundario	string	255		Secondary email for communication.
listasDePreco	string			Price list codes separated by commas. E.g.: 3,4,9.
gruposProduto	string			Product group codes separated by commas.
ocultarGruposDeProduto	int			Values: 0 (display) or 1 (hide) the informed groups.
saldoFlex	decimal			Seller’s flex balance in the ERP.
senhaAtual	string	255		On inclusion, you can set the password if senhaNova is not sent. When updating, it must be sent together with senhaNova and check with the current password.
senhaNova	string	255		New password (minimum 6 characters). Preferential inclusion. It is not returned in the response.
segmentosRelacionados	string	500		Segment codes linked to the seller.
branches	string			Released branch codes, separated by commas.
codVendedorPai	int			Code of the parent seller (agent).
codHierarquiaLiberacaoPedido	string	255		Order release hierarchy code.
saldoFlexAcumulado	decimal			Seller’s accumulated flex balance.
permiteCadastroCliente	int			Values: 0 or 1.
permiteEdicaoCliente	int			Values: 0 or 1.
permiteCadastroDeFotoDeProduto	int			Values: 0 or 1.
permiteAdicionarRota	int			Values: 0 or 1.
permiteControlarRota	int			Values: 0 or 1.
permiteAdicionarRotaClientes	int			Values: 0 or 1.
permiteControlarRotaClientes	int			Values: 0 or 1.
capturarPosGeoNoPedido	int			Values: 0 or 1.
exigeCapturaGPSEventos	int			Values: 0 or 1.
exigeFotoEventos	int			Values: 0 or 1.
exigeCheckinCheckout	int			Values: 0 or 1.
checkinRaio	int			Check-in radius in meters.
checkinDias	int			Number of days for check-in.
permiteVisualizarResumoVendas	int			Values: 0 or 1.
exigeCheckout	int			Values: 0 or 1.
permiteRegistroCobranca	int			Values: 0 or 1.
valorMinimoPedido	decimal			Minimum value allowed for issuing an order.
regraPedidoClienteOutroVendedor	string	30		Values: CONFORME_CONFIG_EMPRESA, SOMENTE_ATIVOS, ATIVOS_INATIVOS, SOMENTE_INATIVOS, NUNCA. Default: CONFORME_CONFIG_EMPRESA.
tiposPedidoLiberados	string	100		Order type codes separated by commas.
comportamentoSaldoFlex	int			Values: 0 (depending on company), 1 (enabled), 2 (disabled). Default: 0.
phone	string	40		Seller’s telephone number. Empty does not update the value already registered.
saldoBonificacaoERP	decimal			Bonus balance in ERP.
observacaoSaldoBonificacao	string	2000		Observation of the bonus balance.

Caution

Inclusion

• It is necessary to send all attributes that are mandatory. Return 201.

Update

• Only the codigo attribute is mandatory. Return 200.

Password

• Upon inclusion, send senhaNova (or senhaAtual) to set the password.
• When updating, send senhaAtual and senhaNova together. If the current password does not match, the password is not changed.
• The password is never returned in the response.Order Range
• numPedidoInicial must be less than numPedidoFinal.
• numPedidoAtual is optional; if sent, it must be within range.

Partial update

• Several optional fields are only saved when sent with a filled value (empty does not clear the record).
• Examples: IMEI, listasDePreco, telefone, saldoFlex, permissions 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"
}

Return:

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

Delete

Remove the seller.

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

Return:

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