Atualizar informações de despacho API 2.0
Serviço destinado a atualização de informações de despacho em uma nota fiscal.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| notafiscal (1) | - | obrigatório | Dados do despacho conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| notafiscal | object | - | obrigatório | Elemento utilizado para representar uma nota fiscal. |
| notafiscal.id | int | - | obrigatório | Identificador da nota fiscal |
| notafiscal.codigoRastreamento | string | 15 | opcional | Código de rastreamento do pedido |
| notafiscal.urlRastreamento (1) | string | 120 | opcional | URL de rastreamento do pedido |
| notafiscal.formaEnvio (2) | string | 1 | opcional | Forma de envio do pedido |
| notafiscal.transportadora (3) | string | 100 | opcional | Nome da tranportadora |
| notafiscal.volumes | int | - | opcional | Número de volumes do pedido |
(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.
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 do parâmetro notafiscal
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/nota.fiscal.cadastrar.codigo.rastreamento.php';
$token = 'coloque aqui a sua chave da api';
$formato = 'JSON';
$notafiscal = '{...}';
$data = "notafiscal=$notafiscal&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;
}
