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
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.XXXXXXXXXXXXXXXXXXXXXXXXX
Responses
A requisição foi bem sucedida e um novo recurso foi criado como resultado
dataobject · required