Você está usando um navegador que não é suportado pelo Tiny. Saiba mais

Obter Contato API 2.0

Serviço destinado a fazer consulta de Contato.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do contato no Tiny
formatostringobrigatórioFormato do retorno (json)
ElementoTipoTamanhoOcorrênciaDescrição
retorno object-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-condicionalConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (7)list -condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.contato (2)object-condicionalElemento utilizado para representar um contato.
retorno.contato.idint-condicionalNúmero de identificação do contato no Tiny
retorno.contato.codigostring30condicionalCódigo do contato
retorno.contato.nomestring50condicionalNome ou razão social do contato
retorno.contato.fantasiastring60condicionalNome fatansia do contato
retorno.contato.tipo_pessoastring1condicionalTipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
retorno.contato.cpf_cnpjstring18condicionalCPF ou CNPJ do contato
retorno.contato.iestring18condicionalInscrição estadual do contato
retorno.contato.rgstring10condicionalRG do contato
retorno.contato.imstring18condicionalInscrição municipal do contato
retorno.contato.enderecostring50condicionalEndereço do contato
retorno.contato.numerostring10condicionalNúmero do endereço do contato
retorno.contato.complementostring50condicionalComplemento do endereço do contato
retorno.contato.bairrostring30condicionalBairro do contato
retorno.contato.cepstring10condicionalCep do contato
retorno.contato.cidadestring30condicionalNome da cidade conforme a Tabela de Cidades
retorno.contato.ufstring30condicionalUF do contato
retorno.contato.paisstring50condicionalNome do País conforme Tabela de Países
retorno.contato.endereco_cobranca (3)string50condicionalEndereço de cobrança do contato
retorno.contato.numero_cobranca (3)string10condicionalNúmero do endereço de cobrança do contato
retorno.contato.complemento_cobranca (3)string50condicionalComplemento do endereço de cobrança do contato
retorno.contato.bairro_cobranca (3)string30condicionalBairro de cobrança do contato
retorno.contato.cep_cobranca (3)string10condicionalCep de cobrança do contato
retorno.contato.cidade_cobranca (3)string30condicionalNome da cidade de cobrança conforme a Tabela de Cidades
retorno.contato.uf_cobranca (3)string30condicionalUF de cobrança do contato
retorno.contato.contatosstring100condicionalPessoas de Contato
retorno.contato.fonestring40condicionalTelefone do Contato
retorno.contato.faxstring40condicionalFax do Contato
retorno.contato.celularstring40condicionalTelefone Celular do Contato
retorno.contato.emailstring50condicionalEmail do Contato
retorno.contato.email_nfestring50condicionalEmail para envio de nfe do Contato
retorno.contato.sitestring40condicionalSite do Contato
retorno.contato.crtstring1condicionalCódigo de regime tributário
retorno.contato.estadoCivil (4)int-condicionalCódigo conforme Tabela Estado Civil
retorno.contato.profissao (4)string50condicionalProfissão do Contato
retorno.contato.sexo (4)string10condicionalSexo do Contato - ("masculino","feminino")
retorno.contato.data_nascimento (4) (5)string10condicionalData de nascimento do contato
retorno.contato.naturalidade (4)string40condicionalNaturalidade do contato
retorno.contato.nome_pai (4)string100condicionalNome do pai do contato
retorno.contato.cpf_pai (4)string18condicionalCPF do pai do contato
retorno.contato.nome_mae (4)string100condicionalNome da mãe do contato
retorno.contato.cpf_mae (4)string18condicionalCPF da mãe do contato
retorno.contato.limite_credito (6)decimal-condicionalLimite de crédito docontato
retorno.contato.situacaostring1condicionalSituação do Contato ("A" - Ativo, "E" - Excluido, "I" - Inativo,"S" - Sem Movimento)
retorno.contato.obsstring200condicionalObservações gerais sobre o contato.
retorno.contato.id_lista_precoint-condicionalNúmero de identificação da lista de preços no Tiny
retorno.contato.id_vendedorint-condicionalNúmero de identificação do Vendedor associado ao contato.
retorno.contato.nome_vendedorstring50condicionalNome do Vendedor associado ao contato.
retorno.contato.data_criacaostring19condicionalData de criação do contato. Formato dd/mm/aaaa hh:mm:ss
retorno.contato.data_atualizacaostring19obrigatórioData da última atualização do contato. Formato dd/mm/aaaa hh:mm:ss
retorno.contato.tipos_contato[]list-condicionalLista de tipos do contato
retorno.contato.tipos_contato[].tipostring30condicionalDescrição do tipo do contato, conforme a tabela de tipos de contatos na sua conta Tiny
retorno.contato.pessoas_contato[]list-condicionalLista de pessoas de contato
retorno.contato.pessoas_contato[].pessoa_contatoobject-condicionalElemento utilizado para representar uma pessoa de contato
retorno.contato.pessoas_contato[].pessoa_contato.id_pessoaint-condicionalNúmero de identificação da pessoa de contato no Tiny
retorno.contato.pessoas_contato[].pessoa_contato.nomestring50condicionalNome da pessoa de contato
retorno.contato.pessoas_contato[].pessoa_contato.telefonestring30condicionalTelefone da pessoa de contato
retorno.contato.pessoas_contato[].pessoa_contato.ramalstring20condicionalRamal da pessoa de contato
retorno.contato.pessoas_contato[].pessoa_contato.emailstring50condicionale-mail da pessoa de contato
retorno.contato.pessoas_contato[].pessoa_contato.departamentostring50condicionalDepartamento da pessoa de contato

(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) - O endereço de cobrança é opcional, deve ser informado somente caso ele seja diferente do endereço do contato.
(4) - Estes campos são opcionais, e devem ser informados somente se o contato seja pessoa física.
(5) - Estes campos devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(6) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(7) - Estes campos somente serão informados caso o retorno contenha erros.


$url = 'https://api.tiny.com.br/api2/contato.obter.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$formato = 'JSON';
$data = "token=$token&id=$id&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;
}