Pesquisar Formas de Recebimento API 2.0

Serviço destinado a fazer consulta de formas de recebimento

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
formato	string	obrigatório	Formato do retorno (json)
situacao ⁽¹⁾	string	opcional	Situação da forma de recebimento (Habilitada ou Desabilitada)

(1) - Caso não seja enviado valor neste parâmetro todas as situações serão consideradas.

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.formasRecebimento[ ] ⁽²⁾	list	-	condicional	Lista de resultados da pesquisa
retorno.formasRecebimento[ ].formaRecebimento ⁽²⁾	object	-	condicional	Elemento utilizado para representar uma forma de recebimento.
retorno.formasRecebimento[ ].formaRecebimento.descricao	string	50	condicional	Descrição da forma de recebimento
retorno.formasRecebimento[ ].formaRecebimento.situacao	string	12	condicional	Situação da forma de recebimento (Habilitada, Desabilitada)

(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/formas.recebimento.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$formato = 'JSON';
$data = "token=$token&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 Formas de Recebimento 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