PDV - 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 a empresa |
pesquisa | string | opcional | Nome ou código (ou parte) do produto que deseja consultar |
dataUltimaSincronizacao | string | opcional | Data da última sincronização de produtos realizada no formato dd/mm/yyyy |
pagina (1) | int | opcional | Número da página |
situacao (2) | string | opcional | Situação dos produtos conforme a tabela de Situações dos Produtos |
(1) - Número da página de produtos que deseja obter (por padrão são listados 100 registros por página). O valor padrão é 1.
(2) - Caso nenhum valor seja passado para este parâmetro, serão pesquisados todos os produtos com situação diferente de excluído ("E").
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) | list | [0..n] | condicional | Contém a lista dos erros encontrados. |
retorno.erros[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.pagina (2) | int | - | condicional | Número da página que está sendo retornada |
retorno.numero_paginas (2) | int | - | condicional | Número de paginas do retorno |
retorno.produtos[] (2) | list | [1..n] | condicional | Lista de resultados da pesquisa |
retorno.produtos[].id | int | - | obrigatório | Número de identificação do produto no Tiny |
retorno.produtos[].descrição | string | 120 | obrigatório | Descrição do produto |
retorno.produtos[].codigo | string | 30 | obrigatório | Código do produto |
retorno.produtos[].tipo | string | - | obrigatório | Produto (P) ou serviço (S) |
retorno.produtos[].preco | decimal | - | obrigatório | Preço de venda |
retorno.produtos[].precoPromocional | decimal | - | obrigatório | Preço promocional de venda |
retorno.produtos[].ncm | string | - | obrigatório | Nomenclatura comun do Mercosul |
retorno.produtos[].unidade | string | - | obrigatório | Unidade |
retorno.produtos[].origem | string | - | obrigatório | Origem do produto conforme ICMS |
retorno.produtos[].cest | string | - | obrigatório | Código especificador da substituição tributária |
retorno.produtos[].gtin | string | - | obrigatório | GTIN / EAN do produto |
retorno.produtos[].gtinTributavel | string | - | obrigatório | GTIN / EAN tributável do produto |
retorno.produtos[].situacao | string | - | obrigatório | Situação no Tiny |
retorno.produtos[].categoria (3) | string | - | obrigatório | Categoria do produto |
retorno.produtos[].idCategoria | int | - | obrigatório | Número de identificação da categoria do produto no Tiny |
retorno.produtos[].classe_produto (7) | string | 1 | obrigatório | Classificação do produto |
retorno.produtos[].tipoVariacao | string | 1 | obrigatório | Tipo de variação "N" - Normal, "P" - Pai, "V" - Variação |
retorno.produtos[].tributacao | object | - | obrigatório | |
retorno.produtos[].tributacao.cfop | string | - | obrigatório | Código fiscal da operação |
retorno.produtos[].tributacao.pis | object | - | obrigatório | Tributação PIS |
retorno.produtos[].tributacao.pis.st | string | - | obrigatório | Situação tributária |
retorno.produtos[].tributacao.pis.aliquota | decimal | - | obrigatório | Alíquota aplicada |
retorno.produtos[].tributacao.cofins | object | - | obrigatório | Tributação COFINS |
retorno.produtos[].tributacao.cofins.st | string | - | obrigatório | Situação tributária |
retorno.produtos[].tributacao.cofins.aliquota | decimal | - | obrigatório | Alíquota aplicada |
retorno.produtos[].tributacao.icms (4) | object | - | condicional | Tributação ICMS |
retorno.produtos[].tributacao.icms.st | string | - | obrigatório | Situação tributária |
retorno.produtos[].tributacao.icms.aliquota | decimal | - | obrigatório | Alíquota aplicada |
retorno.produtos[].tributacao.simples (5) | object | - | condicional | Tributação Simples |
retorno.produtos[].tributacao.simples.st | string | - | obrigatório | Situação tributária |
retorno.produtos[].tributacao.simples.aliquotaAplicavelCredito | decimal | - | obrigatório | Alíquota de crédito aplicada |
retorno.produtos[].tributacao.issqn (6) | object | - | condicional | Tributação ISSQN |
retorno.produtos[].tributacao.issqn.st | string | - | obrigatório | Situação tributária |
retorno.produtos[].tributacao.issqn.aliquota | decimal | - | obrigatório | Alíquota aplicada |
(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) - Este campo retorna a árvore de categorias do produto, utilizando o separador ">>", exemplo: "Categoria pai >> Categoria filha".
(4) - Somente estará presente para produtos (tipo "P") de empresas com regime normal.
(5) - Somente estará presente para produtos (tipo "P") de empresas optantes pelo simples.
(6) - Somente estará presente para serviços (tipo "S").
(7) - Este campo pode ter os valores: S (Simples), K (Kit), V (Com variações), F (Fabricado), M (Matéria-prima).
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/pdv.produtos.php';
$token = 'coloque aqui a sua chave da api';
$pesquisa = 'xxxxx';
$data = "token=$token&pesquisa=$pesquisa";
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;
}