Pesquisar Vendedores API 2.0

Serviço destinado a fazer consulta de vendedores.

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
pesquisa	string	obrigatório	Nome ou código (ou parte) do vendedor que deseja consultar
formato	string	obrigatório	Formato do retorno (json)
pagina ⁽¹⁾	int	opcional	Número da página

(1) - Número da página de vendedores que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.

Elemento	Tipo	Tamanho	Ocorrência	Descrição
retorno	object	-	obrigatório	Elemento raiz do retorno
retorno.status_processamento	int	-	obrigatório	Conforme tabela "Status de Processamento"
retorno.status	string	-	obrigatório	Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro ⁽¹⁾	int	-	condicional	Conforme tabela "Códigos de erro"
retorno.erros[ ] ^{(1) (3)}	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.pagina	int	-	obrigatório	Número da página que está sendo retornada
retorno.numero_paginas	int	-	obrigatório	Número de paginas do retorno
retorno.vendedores[ ] ⁽²⁾	list	-	condicional	Lista de resultados da pesquisa
retorno.vendedores[ ].vendedor ⁽²⁾	object	-	condicional	Elemento utilizado para representar um vendedor.
retorno.vendedores[ ].vendedor.id	int	-	condicional	Número de identificação do vendedor no Tiny
retorno.vendedores[ ].vendedor.codigo	string	30	condicional	Código do vendedor
retorno.vendedores[ ].vendedor.nome	string	50	condicional	Nome ou razão social do contato
retorno.vendedores[ ].vendedor.fantasia	string	60	condicional	Nome fatansia do vendedor
retorno.vendedores[ ].vendedor.tipo_pessoa	string	1	condicional	Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.vendedores[ ].vendedor.cpf_cnpj	string	18	condicional	CPF ou CNPJ do vendedor
retorno.vendedores[ ].vendedor.email	string	50	condicional	Endereço de e-mail do vendedor
retorno.vendedores[ ].vendedor.endereco	string	50	condicional	Endereço do vendedor
retorno.vendedores[ ].vendedor.numero	string	10	condicional	Número do endereço do vendedor
retorno.vendedores[ ].vendedor.complemento	string	50	condicional	Complemento do endereço do vendedor
retorno.vendedores[ ].vendedor.bairro	string	30	condicional	Bairro do vendedor
retorno.vendedores[ ].vendedor.cep	string	10	condicional	Cep do vendedor
retorno.vendedores[ ].vendedor.cidade	string	30	condicional	Nome da cidade conforme a Tabela de Cidades
retorno.vendedores[ ].vendedor.uf	string	30	condicional	UF do vendedor
retorno.vendedores[ ].vendedor.situacao	string	15	condicional	Situação do vendedor (Ativo,Excluido)

(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.

Exemplos da chamada em REST


$url = 'https://api.tiny.com.br/api2/vendedores.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$pesquisa = 'xxxxx';
$formato = 'JSON';
$data = "token=$token&pesquisa=$pesquisa&formato=$formato";

enviarREST($url, $data);    

function enviarREST($url, $data, $optional_headers = null) {
	$params = array('http' => array(
		'method' => 'POST',
	    'content' => $data
	));
	
	if ($optional_headers !== null) {
		$params['http']['header'] = $optional_headers;
	}
	
	$ctx = stream_context_create($params);
	$fp = @fopen($url, 'rb', false, $ctx);
	if (!$fp) {
		throw new Exception("Problema com $url, $php_errormsg");
	}
	$response = @stream_get_contents($fp);
	if ($response === false) {
		throw new Exception("Problema obtendo retorno de $url, $php_errormsg");
	}
	
	return $response;
}

Pesquisar Vendedores API 2.0

Parâmetros do serviço

Retorno do serviço

Exemplos de chamada da API

Exemplos da chamada em REST

Exemplos de retorno da API

Exemplos do retorno do serviço em JSON

Atendimento

Localização