Ajuda do Tiny | API 2.0 | Alterar Expedição | Tiny ERP
Fechar
esqueci a minha senha
criar uma conta

Alterar Expedição API 2.0

Serviço destinado a fazer alterações em uma expedição.

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json ou xml)
expedicao (1)-obrigatórioDados da expedição conforme layout
ElementoTipoTamanhoOcorrênciaDescrição
expedicaoobject-obrigatório
expedicao.id (1)int-obrigatórioID da expedição no Tiny
expedicao.formaEnviostring1opcionalForma de envio: Correios (C), Transportadora (T)
expedicao.qtdVolumesint-opcionalQuantidade de volumes
expedicao.pesoBrutodecimal-opcionalPeso bruto do objeto (Kg)
expedicao.codigoRastreamentostring-opcionalCódigo de rastreamento
expedicao.urlRastreamentostring-opcionalURL de rastreamento
expedicao.possuiValorDeclaradostring1opcionalPossui valor declarado (S/N)
expedicao.valorDeclaradodecimal-opcionalValor declarado do objeto
expedicao.possuiARstring1opcionalPossui aviso de recebimento (S/N)
expedicao.embalagemobject-opcional
expedicao.embalagem.tipoint-opcionalTipo do objeto: não definido (0), envelope (1), pacote / caixa (2) ou rolo / cilindro (3)
expedicao.embalagem.alturadecimal-opcionalAltura do objeto
expedicao.embalagem.larguradecimal-opcionalLargura do objeto
expedicao.embalagem.comprimentodecimal-opcionalComprimento do objeto
expedicao.embalagem.diametrodecimal-opcionalDiâmetro do objeto
expedicao.formaFrete (2)object-opcional
expedicao.formaFrete.idint-opcionalID da forma de frete no Tiny
expedicao.formaFrete.descricao (3)string-opcionalDescrição da forma de frete
expedicao.transportadora (2)object-opcional
expedicao.transportadora.idint-opcionalID da transportadora no Tiny
expedicao.transportadora.nome (3)string-opcionalNome da transportadora

(1) - ID utilizado para identificar a expedição.
(2) - Caso este objeto não seja localizado, será apresentado um erro de validação.
(3) - Este campo será desconsiderado caso haja valor no campo id.

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órioContém o objeto da expedicao
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.alterar.php';
$token = 'coloque aqui a sua chave da api';
$expedicao = '<expedicao>...</expedicao>';
$formato = 'XML';

$data = 'token=$token&expedicao=$expedicao&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>1</codigo_erro>
  <erros>
    <erro>token não informado</erro>
  </erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <expedicao>
    <id>440183098</id>
    <tipoObjeto>venda</tipoObjeto>
    <idObjeto>440183093</idObjeto>
    <idAgrupamento>440222461</idAgrupamento>
    <situacao>1</situacao>
    <dataEmissao>28/02/2018</dataEmissao>
    <formaEnvio>C</formaEnvio>
    <identificacao>Pedido 1000557</identificacao>
    <qtdVolumes>0</qtdVolumes>
    <valorDeclarado>25,94</valorDeclarado>
    <possuiValorDeclarado>S</possuiValorDeclarado>
    <pesoBruto>0,000</pesoBruto>
    <codigoRastreamento>SG021791790BR</codigoRastreamento>
    <urlRastreamento/>
    <possuiAR>N</possuiAR>
    <embalagem>
      <tipo>2</tipo>
      <altura>0,00</altura>
      <largura>0,00</largura>
      <comprimento>0,00</comprimento>
      <diametro>0,00</diametro>
    </embalagem>
    <destinatario>
      <nome>Fulano</nome>
      <endereco/>
      <numero/>
      <complemento/>
      <bairro/>
      <cep/>
      <cidade/>
      <uf/>
    </destinatario>
    <transportadora>
      <id>0</id>
      <nome/>
    </transportadora>
    <formaFrete>
      <id>439989105</id>
      <descricao>SEDEX HOJE (40290)</descricao>
    </formaFrete>
  </expedicao>
</retorno>