Pesquisar Produtos API 2.0
Serviço destinado a fazer consulta de Produtos.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
formato | string | obrigatório | Formato do retorno (json) |
pesquisa | string | obrigatório | Nome ou código (ou parte) do produto que deseja consultar |
idTag | int | opcional | Número de identificação da tag no Tiny |
idListaPreco (1) | int | opcional | Número de identificação da lista de preço no Tiny |
pagina (2) | int | opcional | Número da página |
gtin | string | opcional | GTIN/EAN do produto |
situacao (3) | string | opcional | Situação dos produtos ("A" - Ativo, "I" - Inativo ou "E" - Excluído) |
dataCriacao | string | opcional | Data de criação do produto. Formato dd/mm/aaaa hh:mm:ss |
(1) - Os preços de venda retornados serão calculados de acordo com a lista de preço informada.
(2) - Número da página de produtos que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.
(3) - Caso o parâmetro não seja enviado, serão assumidos os produtos nas situações Ativo e Inativo.
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.pagina | int | - | obrigatório | Número da página que está sendo retornada |
retorno.numero_paginas | int | - | obrigatório | Número de paginas do retorno |
retorno.produtos[ ] (2) | list | - | condicional | Lista de resultados da pesquisa |
retorno.produtos[ ].produto (2) | object | - | condicional | Elemento utilizado para representar um produto. |
retorno.produtos[ ].produto.id | int | - | obrigatório | Número de identificação do produto no Tiny |
retorno.produtos[ ].produto.nome | string | 120 | obrigatório | Nome do produto |
retorno.produtos[ ].produto.codigo | string | 30 | condicional | Código do produto |
retorno.produtos[ ].produto.preco (4) | decimal | - | obrigatório | Preço de venda do produto |
retorno.produtos[ ].produto.preco_promocional (4) | decimal | - | obrigatório | Preço promocional do produto |
retorno.produtos[ ].produto.preco_custo (4) | decimal | - | condicional | Preço de custo do produto |
retorno.produtos[ ].produto.preco_custo_medio (4) | decimal | - | condicional | Preço médio de custo do produto |
retorno.produtos[ ].produto.unidade | string | 3 | condicional | Unidade do produto |
retorno.produtos[ ].produto.gtin | string | 14 | condicional | GTIN/EAN do produto |
retorno.produtos[ ].produto.tipoVariacao | string | 1 | obrigatório | Tipo de variação "N" - Normal, "P" - Pai, "V" - Variação |
retorno.produtos[ ].produto.localizacao | string | 50 | condicional | Localização física no estoque |
retorno.produtos[ ].produto.situacao | string | 1 | condicional | Situação dos produtos ("A" - Ativo, "I" - Inativo, "E" - Excluído) |
retorno.produtos[ ].produto.data_criacao | string | 19 | condicional | Data de criação do produto. Formato dd/mm/aaaa hh:mm:ss |
(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 utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/produtos.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$pesquisa = 'xxxxx';
$data = "token=$token&pesquisa=$pesquisa&formato=JSON";
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;
}