Ajuda do Tiny | API 2.0 | Obter expedições | Tiny ERP
Fechar
esqueci a minha senha
criar uma conta

Obter expedições API 2.0

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

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json ou xml)
idExpedicao (1)stringcondicionalID da expedição no Tiny
idObjeto (2)stringcondicionalID da Nota Fiscal ou Pedido de Venda
tipoObjeto (2)stringcondicionalNota 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.

ElementoTipoTamanhoOcorrênciaDescrição
retorno--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-obrigatórioConforme tabela "Códigos de erro"
retorno.erros[ ] (1)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.expedicao (2)object-obrigatório
retorno.expedicao.idint-obrigatórioID da expedição no Tiny
retorno.expedicao.idObjetoint-obrigatórioID da Nota Fiscal ou Pedido de Venda no Tiny
retorno.expedicao.tipoObjetostring-obrigatórioNota Fiscal (notafiscal) ou Pedido de Venda (venda)
retorno.expedicao.idAgrupamentoint-obrigatórioID do agrupamento vinculado no Tiny
retorno.expedicao.identificacaostring-obrigatórioNúmero da Nota Fiscal ou Pedido de Venda
retorno.expedicao.dataEmissao (3)string-obrigatórioData de emissão da Nota Fiscal ou data da Venda
retorno.expedicao.formaEnviostring1obrigatórioForma de envio: Correios (C), Transportadora (T), Mercado Envios (M) ou B2W Entrega (B)
retorno.expedicao.situacaoint-obrigatórioSituação da expedição: pendente (0) ou concluída (1)
retorno.expedicao.qtdVolumesint-obrigatórioQuantidade de volumes
retorno.expedicao.pesoBrutodecimal-obrigatórioPeso bruto do objeto (Kg)
retorno.expedicao.codigoRastreamentostring-obrigatórioCódigo de rastreamento
retorno.expedicao.urlRastreamentostring-obrigatórioURL de rastreamento
retorno.expedicao.possuiValorDeclaradostring1obrigatórioPossui valor declarado (S/N)
retorno.expedicao.valorDeclaradodecimal-obrigatórioValor declarado do objeto
retorno.expedicao.possuiARstring1obrigatórioPossui aviso de recebimento (S/N)
retorno.expedicao.embalagemobject-obrigatório
retorno.expedicao.embalagem.tipoint-obrigatórioTipo do objeto: não definido (0), envelope (1), pacote / caixa (2) ou rolo / cilindro (3)
retorno.expedicao.embalagem.alturadecimal-obrigatórioAltura do objeto
retorno.expedicao.embalagem.larguradecimal-obrigatórioLargura do objeto
retorno.expedicao.embalagem.comprimentodecimal-obrigatórioComprimento do objeto
retorno.expedicao.embalagem.diametrodecimal-obrigatórioDiâmetro do objeto
retorno.expedicao.destinatarioobject-obrigatório
retorno.expedicao.destinatario.nomestring-obrigatórioNome do destinatário
retorno.expedicao.destinatario.enderecostring-obrigatórioEndereço do destinatário
retorno.expedicao.destinatario.numerostring-obrigatórioNúmero do endereço do destinatário
retorno.expedicao.destinatario.complementostring-obrigatórioComplemento do endereço do destinatário
retorno.expedicao.destinatario.bairrostring-obrigatórioBairro do destinatário
retorno.expedicao.destinatario.cepstring-obrigatórioCEP do destinatário
retorno.expedicao.destinatario.cidadestring-obrigatórioCidade do destinatário
retorno.expedicao.destinatario.ufstring-obrigatórioUF do destinatário
retorno.expedicao.formaFreteobject-obrigatório
retorno.expedicao.formaFrete.idint-obrigatórioID da forma de frete no Tiny
retorno.expedicao.formaFrete.descricaostring-obrigatórioDescrição da forma de frete
retorno.expedicao.transportadoraobject-obrigatório
retorno.expedicao.transportadora.idint-obrigatórioID da transportadora no Tiny
retorno.expedicao.transportadora.nomestring-obrigatórioNome da transportadora

(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.


$url = 'https://SERVER_API_DIRapi2/expedicao.obter.php';
$token = 'coloque aqui a sua chave da api';
$formato = 'XML';

$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;
}
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>1</status_processamento>
  <status>Erro</status>
  <codigo_erro>2</codigo_erro>
  <erros>
    <erro>token invalido</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <expedicao>
    <id>440054394</id>
    <tipoObjeto>venda</tipoObjeto>
    <idObjeto>440054390</idObjeto>
    <idAgrupamento>440192623</idAgrupamento>
    <situacao>1</situacao>
    <dataEmissao>30/01/2018</dataEmissao>
    <formaEnvio>T</formaEnvio>
    <identificacao>Pedido 1000554</identificacao>
    <qtdVolumes>0</qtdVolumes>
    <valorDeclarado>13,08</valorDeclarado>
    <possuiValorDeclarado>S</possuiValorDeclarado>
    <pesoBruto>0,000</pesoBruto>
    <codigoRastreamento/>
    <urlRastreamento/>
    <possuiAR>N</possuiAR>
    <embalagem>
      <tipo>2</tipo>
      <altura>21,00</altura>
      <largura>26,00</largura>
      <comprimento>5,00</comprimento>
      <diametro>0,00</diametro>
    </embalagem>
    <destinatario>
      <nome>JOÃO DA SILVA</nome>
      <endereco>RUA JOANA GUINDANI TONELLO</endereco>
      <numero>1004</numero>
      <complemento>DE 820/821 A 1148/1149</complemento>
      <bairro>COHAB</bairro>
      <cep>95.705-712</cep>
      <cidade>Bento Gonçalves</cidade>
      <uf>RS</uf>
    </destinatario>
    <transportadora>
      <id>440192621</id>
      <nome>TRANSPORTADORA TESTE</nome>
    </transportadora>
    <formaFrete>
      <id>0</id>
      <descricao/>
    </formaFrete>
  </expedicao>
</retorno>