Alterar Contato API 2.0

Serviço destinado a fazer alteração de Contatos.

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
contato ⁽¹⁾	-	obrigatório	Dados do contato conforme layout
formato	string	obrigatório	Formato do retorno (json)

(1) - Layout do parâmetro contato

Elemento	Tipo	Tamanho	Ocorrência	Descrição
contatos[ ]	list	-	obrigatório	Elemento utilizado para representar um conjunto Contatos.
contatos[ ].contato	object	-	obrigatório	Elemento utilizado para representar um Contato.
contatos[ ].contato.sequencia	inteiro	-	obrigatório	Número sequencial utilizado para identificar cada contato.
contatos[ ].contato.id ⁽¹⁾	int		opcional	Número de identificação do Contato no Tiny.
contatos[ ].contato.codigo ⁽¹⁾	string	30	opcional	Código do contato
contatos[ ].contato.nome	string	50	obrigatório	Nome ou razão social do contato
contatos[ ].contato.fantasia	string	60	opcional	Nome fatansia do contato
contatos[ ].contato.tipo_pessoa	string	1	opcional	Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro)
contatos[ ].contato.cpf_cnpj ⁽¹⁾	string	18	opcional	CPF ou CNPJ do contato
contatos[ ].contato.ie	string	18	opcional	Inscrição estadual do contato
contatos[ ].contato.rg	string	10	opcional	RG do contato
contatos[ ].contato.im	string	18	opcional	Inscrição municipal do contato
contatos[ ].contato.endereco	string	50	opcional	Endereço do contato
contatos[ ].contato.numero	string	10	opcional	Número do endereço do contato
contatos[ ].contato.complemento	string	50	opcional	Complemento do endereço do contato
contatos[ ].contato.bairro	string	30	opcional	Bairro do contato
contatos[ ].contato.cep	string	10	opcional	Cep do contato
contatos[ ].contato.cidade	string	30	opcional	Nome da cidade de cobrança conforme a Tabela de Cidades
contatos[ ].contato.uf	string	30	opcional	UF do contato
contatos[ ].contato.pais	string	50	opcional	Nome do País conforme Tabela de Países
contatos[ ].contato.endereco_cobranca ⁽²⁾	string	50	opcional	Endereço de cobrança do contato
contatos[ ].contato.numero_cobranca ⁽²⁾	string	10	opcional	Número do endereço de cobrança do contato
contatos[ ].contato.complemento_cobranca ⁽²⁾	string	50	opcional	Complemento do endereço de cobrança do contato
contatos[ ].contato.bairro_cobranca ⁽²⁾	string	30	opcional	Bairro de cobrança do contato
contatos[ ].contato.cep_cobranca ⁽²⁾	string	10	opcional	Cep de cobrança do contato
contatos[ ].contato.cidade_cobranca ⁽²⁾	string	30	opcional	Nome da cidade de cobrança conforme a Tabela de Cidades
contatos[ ].contato.uf_cobranca ⁽²⁾	string	30	opcional	UF de cobrança do contato
contatos[ ].contato.contatos	string	100	opcional	Pessoas de Contato
contatos[ ].contato.fone	string	40	opcional	Telefone do Contato
contatos[ ].contato.fax	string	40	opcional	Fax do Contato
contatos[ ].contato.celular	string	40	opcional	Telefone Celular do Contato
contatos[ ].contato.email	string	50	opcional	Email do Contato
contatos[ ].contato.email_nfe	string	50	opcional	Email para envio de nfe do Contato
contatos[ ].contato.site	string	40	opcional	Site do Contato
contatos[ ].contato.crt ⁽¹⁰⁾	int	1	opcional	Código de regime tributário: 0 - Não informado 1 - Simples Nacional 3 - Regime Normal
contatos[ ].contato.estadoCivil ⁽³⁾	int	-	opcional	Código conforme Tabela Estado Civil
contatos[ ].contato.profissao ⁽³⁾	string	50	opcional	Profissão do Contato
contatos[ ].contato.sexo ⁽³⁾	string	10	opcional	Sexo do Contato - ("masculino","feminino")
contatos[ ].contato.data_nascimento ^{(3) (4)}	string	10	opcional	Data de nascimento do contato
contatos[ ].contato.naturalidade ⁽³⁾	string	40	opcional	Naturalidade do contato
contatos[ ].contato.nome_pai ⁽³⁾	string	100	opcional	Nome do pai do contato
contatos[ ].contato.cpf_pai ⁽³⁾	string	18	opcional	CPF do pai do contato
contatos[ ].contato.nome_mae ⁽³⁾	string	100	opcional	Nome da mãe do contato
contatos[ ].contato.cpf_mae ⁽³⁾	string	18	opcional	CPF da mãe do contato
contatos[ ].contato.limite_credito ⁽⁵⁾	decimal	-	opcional	Limite de crédito docontato
contatos[ ].contato.id_vendedor ⁽⁶⁾	int	-	opcional	Número de identificação do Vendedor cadastrado no Tiny.
contatos[ ].contato.nome_vendedor ⁽⁶⁾ ⁽⁷⁾	string	50	opcional	Nome do Vendedor cadastrado no Tiny.
contatos[ ].contato.tipos_contato[ ]	list	-	opcional	Lista de tipos do contato
contatos[ ].contato.tipos_contato[ ].tipo ⁽⁸⁾	string	30	opcional	Descrição do tipo do contato, conforme a tabela de tipos de contatos na sua conta Tiny
contatos[ ].contato.pessoas_contato[ ]	list	-	condicional	Lista de pessoas de contato
contatos[ ].contato.pessoas_contato[ ].pessoa_contato ⁽⁹⁾	object	-	condicional	Elemento utilizado para representar uma pessoa de contato
contatos[ ].contato.pessoas_contato[ ].pessoa_contato.nome	string	50	condicional	Nome da pessoa de contato
contatos[ ].contato.pessoas_contato[ ].pessoa_contato.telefone	string	30	condicional	Telefone da pessoa de contato
contatos[ ].contato.pessoas_contato[ ].pessoa_contato.ramal	string	20	condicional	Ramal da pessoa de contato
contatos[ ].contato.pessoas_contato[ ].pessoa_contato.email	string	50	condicional	e-mail da pessoa de contato
contatos[ ].contato.pessoas_contato[ ].pessoa_contato.departamento	string	50	condicional	Departamento da pessoa de contato
contatos[ ].contato.situacao	string	1	obrigatório	Situação do Contato ("A" - Ativo,"I" - Inativo,"S" - Sem Movimento)
contatos[ ].contato.obs	string	200	opcional	Observações gerais sobre o contato.

(1) - Estes campos são utilizados para localizar o contato que será alterado, a ordem de busca é, id, codigo e cpf_cnpj.
(2) - O endereço de cobrança é opcional, deve ser informado somente caso ele seja diferente do endereço do contato.
(3) - Estes campos são opcionais, e devem ser informados somente caso o contato seja pessoa física.
(4) - Estes campos devem ser informados no formato dd/mm/yyyy, exemplo "01/01/2012".
(5) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(6) - Caso o vendedor não seja localizado será apresentado um erro de validação.
(7) - Este campo será desconsiderado caso haja valor no campo id_vendedor.
(8) - Este campo somente adiciona novos tipos para o contato, não removendo ou alterando os tipos já existentes.
(9) - Este campo somente adiciona novas pessoas de contato, não removendo ou alterando os contatos. Caso o nome de contato já exista, não será adicionado.
(10) - Este campo será desconsiderado se o campo "tipo_pessoa" for igual a "F".

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	-	obrigatório	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.registros[ ]⁽²⁾	list	-	condicional	Lista de resultados do retorno
retorno.registros[ ].registro ⁽²⁾	object	-	condicional	Elemento utilizado para representar um contato.
retorno.registros[ ].registro.sequencia	int	-	condicional	Número sequencial utilizado para identificar cada produto.
retorno.registros[ ].registro.status	string	-	condicional	Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.registros[ ].registro.codigo_erro	int	-	condicional	Conforme tabela "Códigos de erro"
retorno.registros[ ].registro.erros[ ] ⁽³⁾	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.registros[ ].registro.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.registros[ ].registro.id	int	-	condicional	Número de identificação do contato no Tiny

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

Exemplos do parâmetro contato em JSON

Exemplos da chamada em REST


$url = 'https://api.tiny.com.br/api2/contato.alterar.php';
$token = 'coloque aqui a sua chave da api';
$contato = '<contatos>...</contatos>';
$data = "token=$token&contato=$contato&formato=JSON";

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;
}

Alterar Contato API 2.0

Parâmetros do serviço

(1) - Layout do parâmetro contato

Retorno do serviço

Exemplos do parâmetro contato

Exemplos do parâmetro contato em JSON

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