Pesquisar agrupamentos API 2.0
Serviço destinado a pesquisar expedições que possuem agrupamento.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
idAgrupamento | string | opcional | Codigo de agrupamento no Tiny |
dataInicial (1) | string | opcional | Data inicial das expedições |
dataFinal (1) | string | opcional | Data final das expedições |
formaEnvio | string | opcional (2) | Forma de envio, conforme Tabela de forma de envio |
pagina (2) | int | opcional | Número da página |
(1) - Data no formato dd/mm/aaaa.
(2) - Obrigatório caso não seja passado um idAgrupamento.
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.pagina (2) | int | - | obrigatório | Número da página que está sendo retornada |
retorno.numero_paginas (2) | int | - | obrigatório | Número de paginas do retorno |
retorno.codigo_erro (1) | int | - | obrigatório | Conforme tabela "Códigos de erro" |
retorno.erros[ ] (1) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.agrupamentos[] (2) | list | - | obrigatório | |
retorno.agrupamentos[].idAgrupamento | int | - | obrigatório | ID do agrupamento no Tiny |
retorno.agrupamentos[].data (3) | string | - | obrigatório | Data de criação do agrupamento |
retorno.agrupamentos[].idFormaEnvio | int | - | obrigatório | ID da forma de envio no Tiny |
retorno.agrupamentos[].formaEnvio | string | - | obrigatório | Nome da forma de envio |
retorno.agrupamentos[].expedicoes[] (2) | list | - | obrigatório | |
retorno.agrupamentos[].expedicoes[].expedicao | object | - | obrigatório | |
retorno.agrupamentos[].expedicoes[].expedicao.id | int | - | obrigatório | ID da expedição no Tiny |
retorno.agrupamentos[].expedicoes[].expedicao.idObjeto | int | - | obrigatório | ID da Nota Fiscal ou Pedido de Venda no Tiny |
retorno.agrupamentos[].expedicoes[].expedicao.tipoObjeto | string | - | obrigatório | Nota Fiscal (notafiscal) ou Pedido de Venda (venda) |
retorno.agrupamentos[].expedicoes[].expedicao.idAgrupamento | int | - | obrigatório | ID do agrupamento vinculado no Tiny |
retorno.agrupamentos[].expedicoes[].expedicao.identificacao | string | - | obrigatório | Número da Nota Fiscal ou Pedido de Venda |
retorno.agrupamentos[].expedicoes[].expedicao.dataEmissao (3) | string | - | obrigatório | Data de emissão da Nota Fiscal ou data da Venda |
retorno.agrupamentos[].expedicoes[].expedicao.formaEnvio | string | 1 | obrigatório | Forma de envio, conforme Tabela de forma de envio |
retorno.agrupamentos[].expedicoes[].expedicao.situacao | int | - | obrigatório | Situação da expedição: pendente (0) ou concluída (1) |
retorno.agrupamentos[].expedicoes[].expedicao.qtdVolumes | int | - | obrigatório | Quantidade de volumes |
retorno.agrupamentos[].expedicoes[].expedicao.pesoBruto | decimal | - | obrigatório | Peso bruto do objeto (Kg) |
retorno.agrupamentos[].expedicoes[].expedicao.codigoRastreamento | string | - | obrigatório | Código de rastreamento |
retorno.agrupamentos[].expedicoes[].expedicao.urlRastreamento | string | - | obrigatório | URL de rastreamento |
retorno.agrupamentos[].expedicoes[].expedicao.possuiValorDeclarado | string | 1 | obrigatório | Possui valor declarado (S/N) |
retorno.agrupamentos[].expedicoes[].expedicao.valorDeclarado | decimal | - | obrigatório | Valor declarado do objeto |
retorno.agrupamentos[].expedicoes[].expedicao.possuiAR | string | 1 | obrigatório | Possui aviso de recebimento (S/N) |
retorno.agrupamentos[].expedicoes[].expedicao.embalagem | object | - | obrigatório | |
retorno.agrupamentos[].expedicoes[].expedicao.embalagem.tipo | int | - | obrigatório | Tipo do objeto: não definido (0), envelope (1), pacote / caixa (2) ou rolo / cilindro (3) |
retorno.agrupamentos[].expedicoes[].expedicao.embalagem.altura | decimal | - | obrigatório | Altura do objeto |
retorno.agrupamentos[].expedicoes[].expedicao.embalagem.largura | decimal | - | obrigatório | Largura do objeto |
retorno.agrupamentos[].expedicoes[].expedicao.embalagem.comprimento | decimal | - | obrigatório | Comprimento do objeto |
retorno.agrupamentos[].expedicoes[].expedicao.embalagem.diametro | decimal | - | obrigatório | Diâmetro do objeto |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario | object | - | obrigatório | |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.nome | string | - | obrigatório | Nome do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.endereco | string | - | obrigatório | Endereço do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.numero | string | - | obrigatório | Número do endereço do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.complemento | string | - | obrigatório | Complemento do endereço do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.bairro | string | - | obrigatório | Bairro do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.cep | string | - | obrigatório | CEP do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.cidade | string | - | obrigatório | Cidade do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.destinatario.uf | string | - | obrigatório | UF do destinatário |
retorno.agrupamentos[].expedicoes[].expedicao.formaFrete | object | - | obrigatório | |
retorno.agrupamentos[].expedicoes[].expedicao.formaFrete.id | int | - | obrigatório | ID da forma de frete no Tiny |
retorno.agrupamentos[].expedicoes[].expedicao.formaFrete.descricao | string | - | obrigatório | Descrição da forma de frete |
retorno.agrupamentos[].expedicoes[].expedicao.transportadora | object | - | obrigatório | |
retorno.agrupamentos[].expedicoes[].expedicao.transportadora.id | int | - | obrigatório | ID da transportadora no Tiny |
retorno.agrupamentos[].expedicoes[].expedicao.transportadora.nome | string | - | obrigatório | Nome 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.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/expedicao.pesquisar.agrupamentos.php';
$token = 'coloque aqui a sua chave da api';
$formato = 'JSON';
idAgrupamento = '444372456'
$dataInicial = '06/02/2018';
$dataFinal = '24/03/2018';
$formaEnvio = 'S';
$data = "token=$token&formato=$formato&dataInicial=$dataInicial&dataFinal=$dataFinal&formaEnvio=$formaEnvio";
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;
}