Skip to content
DemanderDemanderDemander Docs
Light
English

Demander API - Customers

This article is part of the REST Integration API documentation.

Documentation for consulting, inserting, updating and deleting Customers.

Consultation

Section titled “Consultation”

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

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

Return:

{
"clientes": [
  {
      "idCliente" 19595,
    "codigo": 123456,
    "cpfCNPJ": "12.345.678/0001-99",
    "codCondicaoPagamento": "30DD",
    "codFormaPagamento": "BOLETO",
    "codRegiao": "SUL",
    "codVendedor": 10,
    "codListaPreco": "LP01",
    "codCidade": 4314902,
    "codFilial": "SP01",
    "nomeRazao": "Empresa Exemplo LTDA",
    "nomeFantasia": "Exemplo",
    "tipoPessoa": "J",
    "intervaloVisitas": 7,
    "rgIE": "110.222.333.444",
    "telefone1": "(11) 3333-4444",
    "telefone2": "(11) 98888-7777",
    "emailComprador": "compras@exemplo.com.br",
    "emailNfe": "nfe@exemplo.com.br",
    "emailFinanceiro": "financeiro@exemplo.com.br",
    "contato": "João",
    "endereco": "Av. Paulista",
    "bairro": "Bela Vista",
    "cep": "01310-100",
    "uf": "SP",
    "observacao": null,
    "ativo": 1,
    "bloqueado": 0,
    "numero": 1000,
    "complemento": "Sala 10",
    "latitude": null,
    "longitude": null,
    "bloqueiaFilialUnidade": 0,
    "bloqueiaListaPreco": 0,
    "bloqueiaCondPagamento": 0,
    "bloqueiaFormaPagamento": 0,
    "inscricaoEstadualPessoaFisica": null,
    "codTipoClienteTributario": "CONTRIBUINTE",
    "vendedoresRelacionados": "10,20",
    "prospecto": 0,
    "idAlteracaoERP": null,
    "percAcordoComercial": 0,
    "codTransportadora": "TRANS001",
    "codRedespacho": null,
    "dataNascimento": null,
    "segmentosRelacionados": "01",
    "cro": null,
    "percentualDescontoMaximo": null,
    "codFaixaFrete": null,
    "codGrupoEconomico": null,
    "listaPrecosAdicionais": null,
    "checkinRaio": null,
    "checkinDias": null,
    "condicoesAdicionais": null,
    "observacaoIntegracao": null,
    "limiteCredito": null,
    "percMargemContribuicao": 0,
    "vendedoresPrepostos": null,
    "codHierarquiaLiberacaoPedido": null,
    "codTipoCliente": null,
    "codDivisaoVendas": null,
    "codTipoPedido": null,
    "bloqueiaTipoPedido": 0,
    "tipoPedidoAdicionais": null,
    "valorDescarga": null,
    "permiteAlterarDespesaAcessoria": 1,
    "exigeOrdemDeCompra": 0,
    "dataAlteracao": "2026-07-27 10:00:00"
  }
]
}

Single Customer Consultation

Section titled “Single Customer Consultation”

Returns the complete resource of the informed client.

Rota: {host}/public/v1/clientes?idCliente={idCliente}
Método: GET

Return: the same JSON as the resource (without wrapper), the same as the POST return.

Insert or update

Section titled “Insert or update”

POST upsert by key codigo.

Rota: {host}/public/v1/clientes
Método: POST
Body: json
Property Type Size Mandatory Description
code int ✓ Customer code. Unique identifier used to insert or update (upsert).
codCidade int ✓ City code (IBGE).
nomeRazao string 100 ✓ Name/business name.
tipoPessoa string 1 ✓ F or J.
cpfCNPJ string 18 CPF/CNPJ (automatically formatted).
codCondicaoPagamento string 20 Payment condition code.
codFormaPagamento string 20 Payment method code.
codRegiao string 30 Region code.
codVendedor int Seller code.
codListaPreco string 20 Price list code.
codFilial string 15 Branch code.
nomeFantasia string 100 Trade name.
intervaloVisitas int Visit interval in days.
rgIE string 20 ID/state registration.
phone1 string 255 Main phone.
phone2 string 255 Secondary phone.
emailComprador string 255 Buyer’s email.
emailNfe string 255 Email to NF-e.
emailFinanceiro string 255 Financial email.
contact string 50 Contact name.
address string 100 Public place.
neighborhood string 50 Neighborhood.
cep string 10 ZIP code (automatically formatted).
uf string 2 UF.
observation string 2000 Observation.
active int 0 or 1. Default on inclusion: 1.
blocked int 0 or 1. Default: 0.
number int Address number.
complement string 200 Address complement.
latitude string 50 Latitude.
longitude string 50 Longitude.
bloqueiaFilialUnidade int 0 or 1. Default: 0.
bloqueiaListaPreco int 0 or 1. Default: 0.
bloqueiaCondPagamento int 0 or 1. Default: 0.
bloqueiaFormaPagamento int 0 or 1. Default: 0.
inscricaoEstadualPessoaFisica string 30 IE for individuals.
codTipoClienteTributario string 20 Customer tax type.
vendedoresRelacionados string 500 Seller codes separated by commas.
prospectus int 0 or 1. Default: 0.
idAlteracaoERP string 255 ERP change identifier.
percAcordoComercial number Percentage of the commercial agreement. Default: 0.
codTransportadora string 30 Carrier code.
codRedespacho string 30 Redispatch code.
dataNascimento date Date of birth (Y-m-d).
segmentosRelacionados string Segments separated by commas.
cro string 50 CRO.
percentualDescontoMaximo number Maximum discount percentage.
codFaixaFrete string 30 Freight lane code.
codGrupoEconomico string 100 Economic group code.
listaPrecosAdicionais string 255 Additional Price Lists (CSV).
checkinRaio int Check-in radius.
checkinDias int Check-in days.
condicoesAdicionais string 500 Additional conditions (CSV).
observacaoIntegracao string Integration observation.
limiteCredito number Credit limit.
percMargemContribuicao number Contribution margin. Default: 0.
vendedoresPrepostos string 500 Preposed sellers (CSV).
codHierarquiaLiberacaoPedido string 255 Order release hierarchy.
codTipoCliente string 30 Type of customer.
codDivisaoVendas string 30 Sales division.
codTipoPedido int Order type.
tipoPedidoAdicionais string 255 Additional order types (CSV).
valorDescarga number Discharge value.
permiteAlterarDespesaAcessoria int 0 or 1. Default: 1.
exigeOrdemDeCompra int 0 or 1. Default: 0.

Body:

{
  "codigo": 123456,
  "codCidade": 4314902,
  "nomeRazao": "Empresa Exemplo LTDA",
  "tipoPessoa": "J",
  "cpfCNPJ": "12345678000199",
  "nomeFantasia": "Exemplo",
  "ativo": 1
}

Return:

{
  "idCliente": 14556,
"codigo": 123456,
"cpfCNPJ": "12.345.678/0001-99",
"codCondicaoPagamento": null,
"codFormaPagamento": null,
"codRegiao": null,
"codVendedor": null,
"codListaPreco": null,
"codCidade": 4314902,
"codFilial": null,
"nomeRazao": "Empresa Exemplo LTDA",
"nomeFantasia": "Exemplo",
"tipoPessoa": "J",
"intervaloVisitas": null,
"rgIE": null,
"telefone1": null,
"telefone2": null,
"emailComprador": null,
"emailNfe": null,
"emailFinanceiro": null,
"contato": null,
"endereco": null,
"bairro": null,
"cep": null,
"uf": null,
"observacao": null,
"ativo": 1,
"bloqueado": 0,
"numero": null,
"complemento": null,
"latitude": null,
"longitude": null,
"bloqueiaFilialUnidade": 0,
"bloqueiaListaPreco": 0,
"bloqueiaCondPagamento": 0,
"bloqueiaFormaPagamento": 0,
"inscricaoEstadualPessoaFisica": null,
"codTipoClienteTributario": null,
"vendedoresRelacionados": null,
"prospecto": 0,
"idAlteracaoERP": null,
"percAcordoComercial": 0,
"codTransportadora": null,
"codRedespacho": null,
"dataNascimento": null,
"segmentosRelacionados": null,
"cro": null,
"percentualDescontoMaximo": null,
"codFaixaFrete": null,
"codGrupoEconomico": null,
"listaPrecosAdicionais": null,
"checkinRaio": null,
"checkinDias": null,
"condicoesAdicionais": null,
"observacaoIntegracao": null,
"limiteCredito": null,
"percMargemContribuicao": 0,
"vendedoresPrepostos": null,
"codHierarquiaLiberacaoPedido": null,
"codTipoCliente": null,
"codDivisaoVendas": null,
"codTipoPedido": null,
"bloqueiaTipoPedido": 0,
"tipoPedidoAdicionais": null,
"valorDescarga": null,
"permiteAlterarDespesaAcessoria": 1,
"exigeOrdemDeCompra": 0,
"dataAlteracao": "2026-07-27 10:00:00"
}

Delete

Section titled “Delete”

Excludes the customer by the key codigo in the query string.

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

Return:

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