listar clientes
usado para listar clientes presentes. Os parâmetros obrigatórios são
- Offset
- limit
- data_cadastro
- data_ultima_alteracao
- cpf_cnpj
- token
query Parameters
limitinteger · style: form · explode: truepor exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1offsetinteger · style: form · explode: truepor exemplo se você tiver uma lista de 1 ao 100 se você colocar seu limit em 10 e o offset em 0 você terá como resposta de 1 ao 10. se você colocar o offset em 2 e o limit em 10 você terá como resposta 10 a 20 se voce colocar o offset em 3 e o limit em 10 você terá como resposta 20 a 30 o offset está atrelado ao limit
Example: 1idinteger · style: form · explode: truemostra o id
Um número usado para identificação
Example: 1ativoboolean · style: form · explode: truemostra se está ativo ou inativo
existem sómente dois tipos de respostas
Example: trueno_siteboolean · enum · date-time · style: form · explode: truemostra se está no site ou não
para true ele irá responder S e para false N
Enum values:SNExample: truedata_cadastrostring · style: form · explode: truemostra a data em que foi cadastrado
a sequencia é de ano, mês, dia
Example: 2025-01-20data_ultima_alteracaostring · style: form · explode: truemostra ultima data em que foi alterado
o formato é de ano, dia, mês, hora, minuto, segundo
Example: 2021-03-20-16:40:09cpf_cnpjstring · style: form · explode: truemostra cpf ou o cnpj
o documento pode ser tanto o cpf ou cnpj
Example: 377.775.400-50vendedor_idinteger · style: form · explode: truemostra id do vendedor
um número usado para a identificação de um vendedor
Example: 1tokenstring · style: form · explode: trueO seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXX
Responses
A solicitação foi bem-sucedida
dataobject · required
criar clientes
usado para criar novos clientes. Os parâmetros obrigatórios são
- token
Também é obrigatório enviar o json no body da requisição se tiver em dúvida sobre o que algo no json indica olhe na discrição do parâmetro correspondente
query Parameters
tokenstring · style: form · explode: trueO seu token the acesso
O token é um código alfa numérico de 50 digitos dividido ao meio por um ponto
Example: XXXXXXXXXXXXXXXXXXXXXXXXX.XXXXXXXXXXXXXXXXXXXXXXXXXnomestring · style: form · explode: truenome completo atribuido a request sendo enviada
apelidostring · style: form · explode: trueapelido atribuído ao nome
rgstring · style: form · explode: truerg atrbuído a request
existe a opção de ser isento
Example: 0000000-0cpf_cnpjstring · style: form · explode: truemostra cpf ou o cnpj
o documento pode ser tanto o cpf ou cnpj
Example: 377.775.400-50sexostring · style: form · explode: truesexo atribuído a pessoa associada a request
Example: Fdata_nascimentostring · style: form · explode: truedata de nascimento da pessoa atribuída a request
a sequência é ano,mês,dia
Example: 1990-12-30nome_maestring · style: form · explode: truenome da mãe da pessoa atribuída a request
nome_paistring · style: form · explode: truenome do pai da pessoa atribuída a request
estado_civilstring · style: form · explode: trueestado civil da pessoa atribuída a request
Example: casado(a)suframastring · style: form · explode: truecódigo para zona franca de Manaus
Example: 000000000telefone_comercialstring · style: form · explode: truetelefone comercial atribuído a request
Example: 00 00000-0000telefone_residencialstring · style: form · explode: truetelefone residencial atribuído a request
a formatação é hora - minuto - segundo
Example: 00 00000-0000telefone_celularstring · style: form · explode: truetelefone celular atribuído a request
Example: 00 00000-0000emailstring · style: form · explode: trueemail atribuído a request
Example: exemplo@gmail.comemail_fiscalstring · style: form · explode: trueemail fiscal atribuído a request
Example: exemplo@gmail.comrede_grupo_idinteger · style: form · explode: trueExample: 1observacoesstring · style: form · explode: trueobservações que serão atribuídas a request
Example: exemplo@gmail.comvendedor_idinteger · style: form · explode: truemostra id do vendedor
um número usado para a identificação de um vendedor
Example: 1logradourostring · style: form · explode: trueRua atribuída ao endereço da request
(00) 00000-0000
Example: Rua carneiro Leãocepstring · style: form · explode: truecep do endereço atribuído a request
Example: 00000-000numerointeger · style: form · explode: truenúmero atribuído ao endereço da request
Example: 1bairrostring · style: form · explode: truebairro atribuído ao endereço da request
Example: zona 07cidadestring · style: form · explode: truecidade atribuída ao endereço da request
Example: maringaestadostring · style: form · explode: trueestado do endereço atribuído a request
Example: PRcomplementostring · style: form · explode: truecomplemento do endereço atribuído a request
Example: ap 502codigo_ibge_cidadeinteger · style: form · explode: truecódigo do ibge associado ao endereço da request
Example: 0codigo_ibge_paisnumber · style: form · explode: truecódigo ibge do país do endereço atribuído
Example: 240
Request Body
rgstring · requirednomestring · requiredsexostring · requiredemailstring · requiredapelidostring · requiredsuframastring · requiredcpf_cnpjstring · requiredenderecoobject · requirednome_maestring · requirednome_paistring · requiredobservacoesstring · requiredvendedor_idinteger · requiredemail_fiscalstring · requiredestado_civilstring · requiredrede_grupo_idinteger · requireddata_nascimentostring · requiredendereco_entregaobject · requiredtelefone_celularstring · requiredendereco_cobrancaobject · requiredtelefone_comercialstring · requiredtelefone_residencialstring · required
Responses
A requisição foi bem sucedida e um novo recurso foi criado como resultado
dataobject · required