Obter Produto API 2.0
Serviço destinado a obter os dados do Produto.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
id | int | obrigatório | Número de identificação do produto no Tiny |
formato | string | obrigatório | Formato do retorno (json) |
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.produto (2) | object | - | condicional | Elemento utilizado para representar um produto. |
retorno.produto.id | int | - | condicional | Número de identificação do produto no Tiny |
retorno.produto.data_criacao | string | 19 | condicional | Data de criação do produto. Formato dd/mm/aaaa hh:mm:ss |
retorno.produto.nome | string | 120 | condicional | Nome do produto |
retorno.produto.codigo | string | 30 | condicional | Código do produto |
retorno.produto.unidade | string | 3 | condicional | Unidade do produto |
retorno.produto.preco (4) | decimal | - | condicional | Preço de venda do produto |
retorno.produto.preco_promocional (4) | decimal | - | condicional | Preço promocional do produto |
retorno.produto.ncm | string | 10 | condicional | NCM do produto |
retorno.produto.origem | string | 1 | condicional | Código conforme Tabela Origem |
retorno.produto.gtin | string | 14 | condicional | GTIN/EAN do produto |
retorno.produto.gtin_embalagem | string | 14 | condicional | GTIN/EAN da embalagem do produto |
retorno.produto.localizacao | string | 50 | condicional | Localização física no estoque |
retorno.produto.peso_liquido (4) | decimal | - | condicional | Peso líquido do produto (Kg) |
retorno.produto.peso_bruto (4) | decimal | - | condicional | Peso bruto do produto (Kg) |
retorno.produto.estoque_minimo (4) | decimal | - | condicional | Quantidade mínima do produto no estoque |
retorno.produto.estoque_maximo (4) | decimal | - | condicional | Quantidade maxima do produto no estoque |
retorno.produto.id_fornecedor | int | - | condicional | Número de identificação do fornecedor no Tiny |
retorno.produto.codigo_fornecedor | string | 15 | condicional | Código do fornecedor no Tiny |
retorno.produto.codigo_pelo_fornecedor | string | 20 | condicional | Código do produto pelo fornecedor |
retorno.produto.unidade_por_caixa | string | 3 | condicional | Ítens por embalagem |
retorno.produto.preco_custo (4) | decimal | - | condicional | Preço de custo do produto |
retorno.produto.preco_custo_medio (4) | decimal | - | condicional | Preço médio de custo do produto |
retorno.produto.situacao | string | 1 | condicional | Situação do produto "A" - Ativo, "I" - Inativo |
retorno.produto.tipo | string | 1 | condicional | Indica se é produto("P") ou serviço("S") |
retorno.produto.classe_ipi | string | 5 | condicional | Somente para bebidas e cigarros, classe conforme Tabela Classe de enquadramento do IPI |
retorno.produto.valor_ipi_fixo (4) | decimal | - | condicional | Valor IPI fixo, informar somente em produtos com tributação específica |
retorno.produto.cod_lista_servicos | string | 5 | condicional | Código conforme Tabela Lista de Serviços |
retorno.produto.descricao_complementar | text | - | condicional | Descrição complementar, campo exibido em propostas comerciais e pedidos de venda |
retorno.produto.obs | text | - | condicional | Observações gerais sobre o produto. |
retorno.produto.garantia | text | 20 | condicional | Garantia do produto. |
retorno.produto.cest | text | 9 | condicional | Código CEST do produto. |
retorno.produto.tipoVariacao | string | 1 | obrigatório | Tipo de variação "N" - Normal, "P" - Pai, "V" - Variação |
retorno.produto.variacoes[] (5) | list | - | condicional [0..n] | Lista contendo as variações de um produto pai. |
retorno.produto.variacoes[].variacao | object | - | condicional | Elemento utilizado para representar uma variação. |
retorno.produto.variacoes[].variacao.id | int | - | condicional | Número de identificação da variação no Tiny. |
retorno.produto.variacoes[].variacao.codigo | string | - | condicional | Código da variação. |
retorno.produto.variacoes[].variacao.preco | decimal | - | condicional | Preço da variação. |
retorno.produto.variacoes[].variacao.grade[] (11) | array | - | condicional | Grade da variação. |
produtos[].produto.variacoes[].variacao.mapeamentos[] (13) | array | - | condicional [0..n] | Mapeamentos da variação com o e-commerce. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento | object | - | condicional | Elemento utilizado para representar um mapeamento. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.idEcommerce | int | - | obrigatório | Identificador do e-commerce. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.skuMapeamento | string | - | obrigatório | Identificador do mapeamento no e-commerce. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.skuMapeamentoPai | string | - | obrigatório | Identificador do mapeamento do produto pai no e-commerce. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.idMapeamentoPai | int | - | obrigatório | Identificador do mapeamento do produto pai no Tiny. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.idMapeamento | int | - | obrigatório | Identificador do mapeamento da variação no Tiny. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.preco | decimal | - | condicional | Preço de venda do mapeamento no e-commerce. |
produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.preco_promocional | decimal | - | condicional | Preço promocional do mapeamento no e-commerce. |
retorno.produto.idProdutoPai (6) | int | - | condicional | Id do produto pai. |
retorno.produto.sob_encomenda | string | 1 | obrigatório | Indica se o produto é sob encomenda ("S") ou não ("N"). |
retorno.produto.dias_preparacao | int | 3 | condicional | Indica o número de dias corridos para a preparação do produto. |
retorno.produto.grade[] (6)(11) | array | - | condicional | Grade da variação. |
retorno.produto.marca | string | - | condicional | Marca do produto |
retorno.produto.tipoEmbalagem (7) | int | - | condicional | Tipo da embalagem do produto |
retorno.produto.alturaEmbalagem (4) | decimal | - | condicional | Altura da embalagem do produto em cm |
retorno.produto.larguraEmbalagem (4) | decimal | - | condicional | Largura da embalagem do produto em cm |
retorno.produto.comprimentoEmbalagem (4) | decimal | - | condicional | Comprimento da embalagem do produto em cm |
retorno.produto.diametroEmbalagem (4) | decimal | - | condicional | Diâmetro da embalagem do produto em cm |
retorno.produto.categoria (8) | string | - | condicional | Categoria do produto |
retorno.produto.anexos[] | list | - | condicional [0..n] | Lista contendo imagens e anexos do produto. |
retorno.produto.anexos[].anexo | string | - | condicional | URL de acesso ao anexo / imagem do produto. |
retorno.produto.imagens_externas[] | list | - | condicional [0..n] | Lista contendo URLs de imagens externas do produto. |
retorno.produto.imagens_externas[].imagem_externa | object | - | condicional | Elemento utilizado para representar uma imagem externa. |
retorno.produto.imagens_externas[].imagem_externa.url | string | - | condicional | URL de imagem externa. |
retorno.produto.classe_produto (9) | string | 1 | obrigatório | Classificação do produto. |
retorno.produto.kit[] (10) | list | - | condicional [0..n] | Lista contendo os itens do kit do produto. |
retorno.produto.kit[].item | object | - | condicional | Elemento utilizado para representar um item do kit. |
retorno.produto.kit[].item.id_produto | int | - | obrigatório | Número de identificação do produto no Tiny. |
retorno.produto.kit[].item.quantidade | decimal | - | obrigatório | Quantidade do produto dentro do kit. |
retorno.produto.seo_title (12) | string | 120 | condicional | Título do produto que será exibido nos resultados da busca no Google. |
retorno.produto.seo_keywords (12) | string | 255 | condicional | Utilizado para SEO ou metadados que ajudam a descrever um produto, valores separados por vírgula. |
retorno.produto.link_video (12) | string | 100 | condicional | link do vídeo. |
retorno.produto.seo_description (12) | string | 255 | condicional | Descrição exibida abaixo do título nos resultados da busca no Google. |
retorno.produto.slug (12) | text | - | condicional | Utilizado para identificação legível no link do produto no e-commerce. |
produtos[].produto.mapeamentos[] (14) | array | - | condicional [0..n] | Mapeamentos do produto com o e-commerce. |
produtos[].produto.mapeamentos[].mapeamento | object | - | condicional | Elemento utilizado para representar um mapeamento. |
produtos[].produto.mapeamentos[].mapeamento.idEcommerce | int | - | obrigatório | Identificador do e-commerce. |
produtos[].produto.mapeamentos[].mapeamento.skuMapeamento | string | - | obrigatório | Identificador do mapeamento no e-commerce. |
produtos[].produto.mapeamentos[].mapeamento.idMapeamento | int | - | obrigatório | Identificador do mapeamento no Tiny. |
produtos[].produto.mapeamentos[].mapeamento.preco | decimal | - | condicional | Preço de venda do mapeamento no e-commerce. |
produtos[].produto.mapeamentos[].mapeamento.preco_promocional | decimal | - | condicional | Preço promocional do mapeamento no e-commerce. |
(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".
(5) - Estes campos só estarão preenchidos quando o campo "tipoVariacao" for "P".
(6) - Este campo só estará preenchido quando o campo "tipoVariacao" for "V".
(7) - Este campo retorna os valores: 1 (Envelope), 2 (Pacote / Caixa) ou 3 (Rolo / Cilindro).
(8) - Este campo retorna a árvore de categorias do produto, utilizando o separador ">>", exemplo, "Categoria pai >> Categoria filha".
(9) - Este campo pode ter os valores: S (Simples), K (Kit), V (Com variações), F (Fabricado), M (Matéria-prima).
(10) - Este campo só estará preenchido se o campo classe_produto for igual a 'K'.
(11) - Este campo é um array onde a chave é o tipo da variação (ex: Tamanho, Cor) e o valor é o próprio valor da variação (Ex: GG, Branco).
(12) - Somente estará presente no retorno caso o produto possuir SEO.
(12) - Este campo é um array contendo os identificadores das tags de produto. As tags devem estar pré cadastradas e será somente permitida uma tag por grupo. Se o atributo não for enviado, as tags atuais do produto serão mantidas..
(13) - Este campo é um array contendo os mapeamentos da variação. Esse campo só será retornado mediante envio de um Developer-Id válido no header da requisição.
(14) - Este campo é um array contendo os mapeamentos do produto. Esse campo só será considerado mediante envio de um Developer-Id válido no header da requisição.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/produto.obter.php';
$token = 'coloque aqui a sua chave da api';
$id = 'xxxxx';
$formato = 'JSON';
$data = "token=$token&id=$id&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;
}