Atualizar informações de despacho API 2.0
Serviço destinado a atualização de informações de despacho em um pedido de venda.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
id | int | obrigatório | Número de identificação do pedido no Tiny |
codigoRastreamento | string | opcional | Código de rastreamento do pedido |
urlRastreamento (1) | string | opcional | URL de rastreamento do pedido |
formaEnvio (2) | string | opcional | Forma de envio do pedido |
formaFrete | string | opcional | Forma de frete de acordo com o cadastro no Tiny |
freteEmpresa | decimal | opcional | Frete pago pela empresa |
dataPrevista | string | opcional | Data prevista do pedido no formato dd/mm/yyyy |
transportadora (3) | string | opcional | Nome da tranportadora |
volumes | int | opcional | Número de volumes do pedido |
pesoBruto (4) | decimal | opcional | Peso Bruto do pedido |
pesoLiquido (4) | decimal | opcional | Peso Líquido do pedido |
observacoes | string | opcional | Observações do pedido |
formato | string | obrigatório | Formato do retorno (json) |
(1) - O valor passado para este campo deve ser codificada em formato de url.
(2) - Os valores possíveis são: 'C' para Correios e 'T' para transportador.
(3) - Esse campo somente é considerado caso o campo "formaEnvio" seja "T", e a transportadora deve estar previamente cadastrada no sistema.
(4) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
Retorno do serviço
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 (1) | int | - | condicional | Conforme tabela "Códigos de erro" |
retorno.erros[ ] (1) (2) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Estes campos somente serão informados caso o retorno contenha erros.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/cadastrar.codigo.rastreamento.pedido.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$formato = 'JSON';
$codigoRastreamento = "XABC123412341234";
$dataPrevista = "18/10/2017";
$urlRastreamento = urlencode("http://www2.correios.com.br/sistemas/rastreamento/default.cfm?code=XABC123412341234");
$formaEnvio = "T";
$data = "token=$token&id=$id&codigoRastreamento=$codigoRastreamento&urlRastreamento=$urlRastreamento&dataPrevista=$dataPrevista&formaEnvio=$formaEnvio&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;
}