Pular para o conteúdo
DemanderDemanderDemander Docs
Claro
Português

API do Demander - Clientes

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

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

Consulta

Seção intitulada “Consulta”

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

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

Retorno:

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

Consulta de um único Cliente

Seção intitulada “Consulta de um único Cliente”

Retorna o resource completo do cliente informado.

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

Retorno: o mesmo JSON do resource (sem wrapper), igual ao retorno do POST.

Inserir ou atualizar

Seção intitulada “Inserir ou atualizar”

POST upsert pela chave codigo.

Rota: {host}/public/v1/clientes
Método: POST
Body: json
Propriedade Tipo Tamanho Obrigatório Descrição
codigo int ✓ Código do cliente. Identificador único usado para inserir ou atualizar (upsert).
codCidade int ✓ Código da cidade (IBGE).
nomeRazao string 100 ✓ Nome / razão social.
tipoPessoa string 1 ✓ F ou J.
cpfCNPJ string 18 CPF/CNPJ (formatado automaticamente).
codCondicaoPagamento string 20 Código da condição de pagamento.
codFormaPagamento string 20 Código da forma de pagamento.
codRegiao string 30 Código da região.
codVendedor int Código do vendedor.
codListaPreco string 20 Código da lista de preço.
codFilial string 15 Código da filial.
nomeFantasia string 100 Nome fantasia.
intervaloVisitas int Intervalo de visitas em dias.
rgIE string 20 RG / inscrição estadual.
telefone1 string 255 Telefone principal.
telefone2 string 255 Telefone secundário.
emailComprador string 255 E-mail do comprador.
emailNfe string 255 E-mail para NF-e.
emailFinanceiro string 255 E-mail financeiro.
contato string 50 Nome do contato.
endereco string 100 Logradouro.
bairro string 50 Bairro.
cep string 10 CEP (formatado automaticamente).
uf string 2 UF.
observacao string 2000 Observação.
ativo int 0 ou 1. Padrão na inclusão: 1.
bloqueado int 0 ou 1. Padrão: 0.
numero int Número do endereço.
complemento string 200 Complemento do endereço.
latitude string 50 Latitude.
longitude string 50 Longitude.
bloqueiaFilialUnidade int 0 ou 1. Padrão: 0.
bloqueiaListaPreco int 0 ou 1. Padrão: 0.
bloqueiaCondPagamento int 0 ou 1. Padrão: 0.
bloqueiaFormaPagamento int 0 ou 1. Padrão: 0.
inscricaoEstadualPessoaFisica string 30 IE para pessoa física.
codTipoClienteTributario string 20 Tipo tributário do cliente.
vendedoresRelacionados string 500 Códigos de vendedores separados por vírgula.
prospecto int 0 ou 1. Padrão: 0.
idAlteracaoERP string 255 Identificador de alteração no ERP.
percAcordoComercial number Percentual do acordo comercial. Padrão: 0.
codTransportadora string 30 Código da transportadora.
codRedespacho string 30 Código de redespacho.
dataNascimento date Data de nascimento (Y-m-d).
segmentosRelacionados string Segmentos separados por vírgula.
cro string 50 CRO.
percentualDescontoMaximo number Percentual máximo de desconto.
codFaixaFrete string 30 Código da faixa de frete.
codGrupoEconomico string 100 Código do grupo econômico.
listaPrecosAdicionais string 255 Listas de preço adicionais (CSV).
checkinRaio int Raio de check-in.
checkinDias int Dias de check-in.
condicoesAdicionais string 500 Condições adicionais (CSV).
observacaoIntegracao string Observação de integração.
limiteCredito number Limite de crédito.
percMargemContribuicao number Margem de contribuição. Padrão: 0.
vendedoresPrepostos string 500 Vendedores prepostos (CSV).
codHierarquiaLiberacaoPedido string 255 Hierarquia de liberação de pedido.
codTipoCliente string 30 Tipo de cliente.
codDivisaoVendas string 30 Divisão de vendas.
codTipoPedido int Tipo de pedido.
bloqueiaTipoPedido int 0 ou 1. Padrão: 0.
tipoPedidoAdicionais string 255 Tipos de pedido adicionais (CSV).
valorDescarga number Valor de descarga.
permiteAlterarDespesaAcessoria int 0 ou 1. Padrão: 1.
exigeOrdemDeCompra int 0 ou 1. Padrão: 0.

Body:

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

Retorno:

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

Excluir

Seção intitulada “Excluir”

Exclui o cliente pela chave codigo na query string.

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

Retorno:

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