Enviar objetos para a expedição API 2.0
Serviço destinado para enviar notas fiscais e pedidos de vendas para a expedição.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| idObjetos | string | obrigatório | IDs das vendas ou notas fiscais separados por vírgula. Por exemplo: 1,2,3,4 |
| tipoObjetos | string | obrigatório | Os objetos são Notas Fiscais (notafiscal) ou Vendas (venda) |
| formato | string | obrigatório | Formato do retorno (json) |
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 | - | 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.objetos[] (2) | list | - | obrigatório [0..n] | Contém a lista de objetos |
| retorno.objetos[].objeto | list | - | obrigatório | Elemento utilizado para representar um objeto |
| retorno.objetos[].objeto.idExpedicao | int | - | condicional | Identificação da expedição criada |
| retorno.objetos[].objeto.idObjeto | int | - | condicional | Identificação do objeto recebido como parâmetro |
| retorno.objetos[].objeto.sucesso | int | 1 | condicional | Sucesso (1) ou erro (0) ao enviar objeto para a expedição. |
| retorno.objetos[].objeto.erro | string | - | condicional | Mensagem contendo a descrição do erro |
(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".
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/expedicao.liberar.objetos.php';
$token = 'coloque aqui a sua chave da api';
$tipoObjetos = 'venda';
$objetos = '54644654,6498789';
$formato = 'JSON';
$data = "tipoObjetos=$tipoObjetos&idObjetos=$objetos&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;
}
