Obter Forma de Envio API 2.0

Serviço destinado para a obtenção de uma forma de envio.

REST

REST URL

Elemento	Tipo	Ocorrência	Descrição
token	string	obrigatório	Chave gerada para identificar sua empresa
idFormaEnvio	int	obrigatório	ID da forma de envio

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 ⁽¹⁾	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.forma_envio ⁽²⁾	list	-	condicional	Elemento com a forma de envio cadastrada
retorno.forma_envio.id	int	-	obrigatório	ID da forma de envio
retorno.forma_envio.nome	string	30	obrigatório	Nome da forma de envio
retorno.forma_envio.situacao	int	-	obrigatório	Situação da forma de envio. Conforme tabela de Situações das formas de envio
retorno.forma_envio.tipo_logistica	int	-	obrigatório	Código do tipo de logística. Conforme tabela de Tipos de logística
retorno.forma_envio.id_gateway_logistico ⁽⁴⁾	int	-	opcional	ID do gateway logístico
retorno.forma_envioformas_frete[ ]	list	-	opcional [0..n]	Contém a lista das formas de frete cadastradas para a forma de envio
retorno.forma_envio.formas_frete[ ].id	int	-	obrigatório	ID da forma de frete
retorno.forma_envio.formas_frete[ ].descricao	string	60	obrigatório	Descrição da forma de frete
retorno.forma_envio.formas_frete[ ].codigo	string	60	obrigatório	Código do serviço da forma de frete
retorno.forma_envio.formas_frete[ ].codigo_externo ⁽⁴⁾	string	30	opcional	Código externo da forma de frete
retorno.forma_envio.formas_frete[ ].tipo_entrega ⁽⁴⁾	int	-	condicional	Código do tipo de entrega da forma de frete. Conforme tabela de Tipos de entrega

(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) - Estes campos somente serão retornados caso a forma de envio possua integração com algum gateway logístico.

Exemplos da chamada


    $url = 'https://api.tiny.com.br/api2/formas.envio.obter.php';
    $token = 'coloque aqui a sua chave da api';
    $idFormaEnvio = '123';
    $data = "token=$token&idFormaEnvio=$idFormaEnvio";

    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;
    }

Obter Forma de Envio API 2.0

Parâmetros do serviço

Retorno do serviço

Exemplos de chamada da API

Exemplos da chamada

Exemplos de retorno da API

Exemplos do retorno do serviço

Atendimento

Localização