Ir al contenido
DemanderDemanderDemander Docs
Claro
Español

API de Demander - Clientes

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

Documentación para consultar, alta, actualización y baja de Clientes.

Consulta

Sección titulada «Consulta»

Enumere los clientes de la empresa. Sin filtro, considera dataAlteracao de los ú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 cliente único

Sección titulada «Consulta de cliente único»

Devuelve el recurso completo del cliente informado.

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

Retorno: el mismo JSON que el recurso (sin contenedor), igual que el retorno POST.

Insertar o actualizar

Sección titulada «Insertar o actualizar»

POST inserción mediante la tecla codigo.

Rota: {host}/public/v1/clientes
Método: POST
Body: json
Propiedad Tipo Tamaño Obligatorio Descripción
código entero ✓ Código de cliente. Identificador único utilizado para insertar o actualizar (upsert).
codCidade entero ✓ Código de ciudad (IBGE).
nomeRazao cadena 100 ✓ Nombre/razón social.
tipoPessoa cadena 1 ✓ F o J.
cpfCNPJ cadena 18 CPF/CNPJ (formateado automáticamente).
codCondicaoPagamento cadena 20 Código de condición de pago.
codFormaPagamento cadena 20 Código de método de pago.
codRegiao cadena 30 Código de región.
codVendedor entero Código de vendedor.
codListaPreco cadena 20 Código de lista de precios.
codFilial cadena 15 Código de sucursal.
nomeFantasia cadena 100 Nombre comercial.
intervaloVisitas entero Intervalo de visita en días.
rgIE cadena 20 Identificación/registro estatal.
teléfono1 cadena 255 Teléfono principal.
teléfono2 cadena 255 Teléfono secundario.
emailComprador cadena 255 Correo electrónico del comprador.
emailNfe cadena 255 Envíe un correo electrónico a NF-e.
emailFinanceiro cadena 255 Correo electrónico financiero.
contacto cadena 50 Nombre de contacto.
dirección cadena 100 Lugar público.
barrio cadena 50 Vecindario.
cep cadena 10 Código postal (formateado automáticamente).
uf cadena 2 UF.
observación cadena 2000 Observación.
activo entero 0 o 1. Valor predeterminado de inclusión: 1.
bloqueado entero 0 o 1. Predeterminado: 0.
número entero Número de dirección.
complemento cadena 200 Complemento de dirección.
latitud cadena 50 Latitud.
longitud cadena 50 Longitud.
bloqueiaFilialUnidade entero 0 o 1. Predeterminado: 0.
bloqueiaListaPreco entero 0 o 1. Predeterminado: 0.
bloqueiaCondPagamento entero 0 o 1. Predeterminado: 0.
bloqueiaFormaPagamento entero 0 o 1. Predeterminado: 0.
inscricaoEstadualPessoaFisica cadena 30 Es decir, para particulares.
codTipoClienteTributario cadena 20 Tipo de impuesto del cliente.
vendedoresRelacionados cadena 500 Códigos de vendedor separados por comas.
prospecto entero 0 o 1. Predeterminado: 0.
idAlteracaoERP cadena 255 Identificador de cambio de ERP.
percAcordoComercial número Porcentaje del acuerdo comercial. Predeterminado: 0.
codTransportadora cadena 30 Código de operador.
codRedespacho cadena 30 Código de reenvío.
dataNascimento fecha Fecha de nacimiento (Y-m-d).
segmentosRelacionados cadena Segmentos separados por comas.
cro cadena 50 CRO.
percentualDescontoMaximo número Porcentaje máximo de descuento.
codFaixaFrete cadena 30 Código de carril de mercancías.
codGrupoEconomico cadena 100 Código de grupo económico.
listaPrecosAdicionais cadena 255 Listas de precios adicionales (CSV).
checkinRaio entero Radio de entrada.
checkinDias entero Días de entrada.
condicoesAdicionais cadena 500 Condiciones adicionales (CSV).
observacaoIntegracao cadena Observación de integración.
limiteCredito número Límite de crédito.
percMargemContribuicao número Margen de contribución. Predeterminado: 0.
vendedoresPrepostos cadena 500 Vendedores prepuestos (CSV).
codHierarquiaLiberacaoPedido cadena 255 Jerarquía de liberación de pedidos.
codTipoCliente cadena 30 Tipo de cliente.
codDivisaoVendas cadena 30 División de ventas.
codTipoPedido entero Tipo de orden.
tipoPedidoAdicionais cadena 255 Tipos de pedidos adicionales (CSV).
valorDescarga número Valor de descarga.
permiteAlterarDespesaAcessoria entero 0 o 1. Predeterminado: 1.
exigeOrdemDeCompra entero 0 o 1. Predeterminado: 0.

Cuerpo:

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

Eliminar

Sección titulada «Eliminar»

Excluye al cliente mediante la clave codigo en la cadena de consulta.

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

Retorno:

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