Método
O nome do método utilizado na consulta é getClientes.
Descrição
Este método retorna uma listagem com os dados dos clientes.
Filtros
Os filtros são organizados em uma tabela contendo o nome, tipo e descrição de cada filtro.
Nome | Tipo | Descrição |
limite | Integer(10) | Define a quantidade de registros a retornar. |
pagina | integer(10) | Filtra a página exibida conforme o limite de produtos que é retornado |
tipo_pessoa | Integer(1) | Busca por clientes do tipo pessoa física ou jurídica: 0 - Pessoa física 1 - Pessoa jurídica |
nome | String(100) | Busca por clientes com um nome específico. |
cpf_cnpj | String(20) | Busca por clientes com um CPF caso pessoa física, ou CNPJ caso pessoa jurídica. |
cep | String(10) | Busca por clientes de um determinado CEP. |
cidade | String(50) | Busca por clientes de uma determinada cidade. |
estado | String(2) | Busca por clientes de um determinado estado: Exemplo: RS, SP, SC ... |
String(120) | Busca por clientes com um determinado e-mail. | |
data_cadastro | String(19) | Busca pela data exata de cadastro dos clientes (Y-m-d h:m:s): ‘2015-12-20’, ‘2016-02-13 00:00:00’. |
codigo | Integer(11) | Busca por clientes com um determinado código. |
autorizo_newsletter | Integer(11) | Busca por clientes que autorizam newsletters. |
autorizo_sms | Integer(11) | Busca por clientes que autorizam sms. |
Observações
O filtro de data de cadastro não é maior nem menor, é exatamente. Para buscar clientes de um dia, ‘2016-01-13’ ou de um mês, ‘2016-01’.
Retorno
Os retornos são organizados em uma tabela contendo grupo do campo, nome, tipo, e descrição de cada campo.
Grupo | Nome | Tipo | Descrição |
raiz | clientes |
| Campo principal da estrutura. Todos clientes da consulta são retornados dentro dele. |
clientes | cliente |
| Contém os dados referentes a um cliente. |
cliente | codigo_cliente | Integer(11) | Identificador do cliente na plataforma. |
cliente | status | Tinyint(1) | Status do cliente na plataforma: “0” - Desativado “1” - Ativado |
cliente | data_cadastro | Datetime | Data de cadastro do cliente na plataforma. |
cliente | tipo_pessoa | Tinyint(1) | Tipo de cliente: “0” - Pessoa Física “1” - Pessoa Jurídica |
cliente | nome | Varchar(100) | Nome do cliente. |
cliente | inscricao_estadual | Varchar(25) | Número da inscrição estadual. |
cliente | inscricao_estadual_isento | Tinyint(1) | Isenção de inscrição estadual: “0” - Não “1” - Sim |
cliente | nome_fantasia | Varchar(120) | Nome fantasia do cliente/empresa. |
cliente | estado_civil | Varchar(3) | Estado cívil do cliente: “n/a” - Não definido “1” - Solteiro “2” - Casado “3” - Separado “4” - Divorciado “5” - Outros |
cliente | data_nasc | Date | Data de nascimento do cliente. |
cliente | sexo | Varchar(10) | Gênero do cliente: “n/a” - Não definido “M” - Masculino “F” - Feminino |
cliente | cpf_cnpj | Varchar(20) | Número do CPF ou CNPJ do cliente. |
cliente | rg | Varchar(20) | Número do RG do cliente. |
cliente | contribuinte | Varchar(10) | Define de o cliente é contribuinte: “n/a” - Não definido “N” - Não “S” - Sim |
cliente | contato | Varchar(120) | Nome de contato do cliente. |
cliente | endereco | Varchar(150) | Endereço de origem do cliente. |
cliente | numero | Varchar(10) | Número de endereço de origem do cliente. |
cliente | complemento | Varchar(130) | Complemento do endereço de origem do cliente. |
cliente | bairro | Varchar(30) | Bairro de origem do cliente. |
cliente | instrucoes | Varchar(100) | Instruções do endereço de origem do cliente. |
cliente | cep | Varchar(50) | Código do CEP de origem do cliente. |
cliente | cidade | Varchar(50) | Cidade de origem do cliente. |
cliente | estado | Varchar(100) | Estado de origem do cliente. |
cliente | Varchar(120) | Endereço de Email principal. | |
cliente | email_secundario | Varchar(120) | Endereço de Email secundário. |
cliente | telefone_res | Varchar(15) | Telefone residencial. |
cliente | telefone_cel | Varchar(15) | Telefone celular. |
cliente | telefone_com | Varchar(15) | Telefone comercial. |
cliente | pais | Varchar(3) | Sigla do pais do cliente. |
cliente | grupo | Varchar(70) | Grupo do cliente. |
cliente | autorizo_newsletter | Tinyint(1) | Autoriza receber Newsletter: “0” - Não “1” - Sim |
cliente | autorizo_sms | Tinyint(1) | Autoriza receber Sms: “0” - Não “1” - Sim |
cliente | campos_estendidos | Array | Contém todos os campos estendidos do cliente |
cliente | campo_estendido |
| Cada campo estendido |
campo_estendido | nome_campo | Varchar(100) | Título do campo estendido |
campo_estendido | opcao | Varchar(100) | Opção escolhida no campo estendido |
Exemplo de retorno
XML:
<clientes>
<cliente>
<codigo_cliente>1</codigo_cliente>
<status>1</status>
<data_cadastro>2015-08-28 11:08:32</data_cadastro>
<tipo_pessoa>0</tipo_pessoa>
<nome>João da Silva</nome>
<inscricao_estadual />
<inscricao_estadual_isento>0</inscricao_estadual_isento>
<nome_fantasia />
<estado_civil>n/a</estado_civil>
<data_nasc>1993-04-13</data_nasc>
<sexo>M</sexo>
<autorizo_newsletter>1</autorizo_newsletter>
<autorizo_sms>1</autorizo_sms>
<cpf_cnpj>12364557897</cpf_cnpj>
<rg>11.113.116-9</rg>
<contribuinte>N</contribuinte>
<contato />
<endereco>Rua</endereco>
<numero>123</numero>
<complemento>Casa</complemento>
<bairro>Centro</bairro>
<instrucoes>Instrução</instrucoes>
<cep>84600000</cep>
<cidade>União da Vitória</cidade>
<estado>PR</estado>
<email>exemplo@mail.com</email>
<email_secundario></email_secundario>
<telefone_res>(51) 123456748</telefone_res>
<telefone_cel>(42) 88000000</telefone_cel>
<telefone_com />
<pais />
<grupo>Varejo</grupo>
<campos_estendidos>
<campo_estendido>
<nome_campo>teste1</nome_campo>
<opcao>12345</opcao>
</campo_estendido>
</campos_estendidos>
</cliente>
</clientes>
JSON:
{
"clientes":{
"cliente":{
"codigo_cliente":"1",
"status":"1",
"data_cadastro":"2015-08-28 11:08:32",
"tipo_pessoa":"0",
"nome":"João da Silva",
"inscricao_estadual":{
},
"inscricao_estadual_isento":"0",
"nome_fantasia":{
},
"estado_civil":"n/a",
"data_nasc":"1993-04-13",
"sexo":"M",
"autorizo_newsletter":"1",
"autorizo_sms":"1",
"cpf_cnpj":"12364557897",
"rg":"11.113.116-9",
"contribuinte":"N",
"contato":{
},
"endereco":"Rua",
"numero":"123",
"complemento":"Casa",
"bairro":"Centro",
"instrucoes":"Instrução",
"cep":"84600000",
"cidade":"União da Vitória",
"estado":"PR",
"email":"exemplo@mail.com",
"email_secundario":{
},
"telefone_res":"(51) 123456748",
"telefone_cel":"(42) 88000000",
"telefone_com":{
},
"pais":{
},
"grupo":"Varejo",
"campos_estendidos":{
"campo_estendido":{
"nome_campo":"teste1",
"opcao":"12345"
}
}
}
}
}
Mais sobre Webservice
Consulte nossa tabela de retorno aqui.
Não conhece todos os métodos webservice da Moovin? Veja nossa lista completa aqui.
Caso tenha dúvidas em como realizar o envio ou formatos de envio, veja nesta nossa documentação aqui.