Obter expedições API 2.0

Serviço destinado a obter detalhes da expedição.

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)
idExpedicao ⁽¹⁾	string	condicional	ID da expedição no Tiny
idObjeto ⁽²⁾	string	condicional	ID da Nota Fiscal ou Pedido de Venda
tipoObjeto ⁽²⁾	string	condicional	Nota Fiscal (notafiscal) ou Pedido de Venda (venda)

(1) - Pode ser substituido pelo idObjeto.
(2) - Somente considerado caso não seja enviado o parâmetro idExpedicao.

Elemento	Tipo	Tamanho	Ocorrência	Descrição
retorno	-	-	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[ ] ⁽¹⁾	list	-	condicional [0..n]	Contém a lista dos erros encontrados.
retorno.erros[ ].erro	string	-	condicional	Mensagem contendo a descrição do erro
retorno.expedicao ⁽²⁾	object	-	obrigatório
retorno.expedicao.id	int	-	obrigatório	ID da expedição no Tiny
retorno.expedicao.idObjeto	int	-	obrigatório	ID da Nota Fiscal ou Pedido de Venda no Tiny
retorno.expedicao.tipoObjeto	string	-	obrigatório	Nota Fiscal (notafiscal) ou Pedido de Venda (venda)
retorno.expedicao.idAgrupamento	int	-	obrigatório	ID do agrupamento vinculado no Tiny
retorno.expedicao.identificacao	string	-	obrigatório	Número da Nota Fiscal ou Pedido de Venda
retorno.expedicao.dataEmissao ⁽³⁾	string	-	obrigatório	Data de emissão da Nota Fiscal ou data da Venda
retorno.expedicao.formaEnvio	string	1	obrigatório	Forma de envio, conforme Tabela de forma de envio
retorno.expedicao.situacao	int	-	obrigatório	Situação da expedição: pendente (0) ou concluída (1)
retorno.expedicao.qtdVolumes	int	-	obrigatório	Quantidade de volumes
retorno.expedicao.pesoBruto	decimal	-	obrigatório	Peso bruto do objeto (Kg)
retorno.expedicao.codigoRastreamento	string	-	obrigatório	Código de rastreamento
retorno.expedicao.urlRastreamento	string	-	obrigatório	URL de rastreamento
retorno.expedicao.possuiValorDeclarado	string	1	obrigatório	Possui valor declarado (S/N)
retorno.expedicao.valorDeclarado	decimal	-	obrigatório	Valor declarado do objeto
retorno.expedicao.possuiAR	string	1	obrigatório	Possui aviso de recebimento (S/N)
retorno.expedicao.embalagem	object	-	obrigatório
retorno.expedicao.embalagem.tipo	int	-	obrigatório	Tipo do objeto: não definido (0), envelope (1), pacote / caixa (2) ou rolo / cilindro (3)
retorno.expedicao.embalagem.altura	decimal	-	obrigatório	Altura do objeto
retorno.expedicao.embalagem.largura	decimal	-	obrigatório	Largura do objeto
retorno.expedicao.embalagem.comprimento	decimal	-	obrigatório	Comprimento do objeto
retorno.expedicao.embalagem.diametro	decimal	-	obrigatório	Diâmetro do objeto
retorno.expedicao.destinatario	object	-	obrigatório
retorno.expedicao.destinatario.nome	string	-	obrigatório	Nome do destinatário
retorno.expedicao.destinatario.endereco	string	-	obrigatório	Endereço do destinatário
retorno.expedicao.destinatario.numero	string	-	obrigatório	Número do endereço do destinatário
retorno.expedicao.destinatario.complemento	string	-	obrigatório	Complemento do endereço do destinatário
retorno.expedicao.destinatario.bairro	string	-	obrigatório	Bairro do destinatário
retorno.expedicao.destinatario.cep	string	-	obrigatório	CEP do destinatário
retorno.expedicao.destinatario.cidade	string	-	obrigatório	Cidade do destinatário
retorno.expedicao.destinatario.uf	string	-	obrigatório	UF do destinatário
retorno.expedicao.formaFrete	object	-	obrigatório
retorno.expedicao.formaFrete.id	int	-	obrigatório	ID da forma de frete no Tiny
retorno.expedicao.formaFrete.descricao	string	-	obrigatório	Descrição da forma de frete
retorno.expedicao.transportadora	object	-	obrigatório
retorno.expedicao.transportadora.id	int	-	obrigatório	ID da transportadora no Tiny
retorno.expedicao.transportadora.nome	string	-	obrigatório	Nome da transportadora
retorno.expedicao.numeroPLP ⁽⁴⁾	int	-	condicional	Numero da pré-lista de postagem (PLP).

(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) - Data no formato dd/mm/aaaa.
(4) - O retorno do número da PLP fica condicionado a sua geração e a forma de envio "Correios (C)".

Exemplos da chamada em REST


$url = 'https://api.tiny.com.brapi2/expedicao.obter.php';
$token = 'coloque aqui a sua chave da api';
$formato = 'JSON';

$tipoObjeto = 'venda';
$idObjeto = '112233';
$data = "tipoObjeto=$tipoObjeto&idObjeto=$idObjeto&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;
}

Obter expedições 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