Pesquisar Formas de Envio API 2.0
Serviço destinado para a consulta de formas de envio.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
tipoLogistica | int | opcional | Código do tipo de logística. Conforme tabela de Tipos de logística |
Retorno do serviço
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
retorno | object | - | 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) (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.registros[ ] (2) | list | - | condicional | Lista de resultados da pesquisa |
retorno.registros[ ].id | int | - | obrigatório | ID da forma de envio |
retorno.registros[ ].nome | string | 60 | obrigatório | Nome da forma de envio |
retorno.registros[ ].situacao | int | - | obrigatório | Situação da forma de envio. Conforme tabela de Situações das formas de envio |
retorno.registros[ ].tipo_logistica | int | - | obrigatório | Código do tipo de logística. Conforme tabela de Tipos de logística |
retorno.registros[ ].id_gateway_logistico (4) | int | - | condicional | ID do gateway logístico |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
(4) - Este campo somente será retornado caso a forma de envio possua integração com algum gateway logístico.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/formas.envio.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$tipoLogistica = '3';
$data = "token=$token&tipoLogistica=$tipoLogistica";
enviarREST($url, $data);
function enviarREST($url, $data, $optional_headers = null) {
$params = array('http' => array(
'method' => 'GET',
'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;
}