Alterar Produto API 2.0
Serviço destinado a fazer alteração de Produtos.
Parâmetros do serviço
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| produto (1) | - | obrigatório | Dados do produto conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Elemento | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| produtos[] | list | - | obrigatório | Elemento utilizado para representar um conjunto Produtos. |
| produtos[].produto | object | - | obrigatório | Elemento utilizado para representar um Produto. |
| produtos[].produto.sequencia | inteiro | - | obrigatório | Número sequencial utilizado para identificar cada produto. |
| produtos[].produto.id (2) | int | opcional | Número de identificação do Produto no Tiny. | |
| produtos[].produto.codigo (2) | string | 30 | opcional | Código do produto |
| produtos[].produto.nome (2) | string | 120 | obrigatório | Nome do produto |
| produtos[].produto.unidade | string | 3 | obrigatório | Unidade do produto |
| produtos[].produto.preco (3) | decimal | - | obrigatório | Preço de venda do produto |
| produtos[].produto.preco_promocional (3) (16) | decimal | - | opcional | Preço promocional do produto |
| produtos[].produto.ncm | string | 10 | opcional | NCM do produto |
| produtos[].produto.origem | string | 1 | obrigatório | Código conforme Tabela Origem |
| produtos[].produto.gtin | string | 14 | opcional | GTIN/EAN do produto |
| produtos[].produto.gtin_embalagem | string | 14 | opcional | GTIN/EAN da embalagem do produto |
| produtos[].produto.localizacao | string | 50 | condicional | Localização física no estoque |
| produtos[].produto.peso_liquido (3) | decimal | - | opcional | Peso líquido do produto (Kg) |
| produtos[].produto.peso_bruto (3) | decimal | - | opcional | Peso bruto do produto (Kg) |
| produtos[].produto.estoque_minimo (3) | decimal | - | opcional | Quantidade mínima do produto no estoque |
| produtos[].produto.estoque_maximo (3) | decimal | - | opcional | Quantidade maxima do produto no estoque |
| produtos[].produto.id_fornecedor (4) | int | - | opcional | Número de identificação do fornecedor no Tiny |
| produtos[].produto.codigo_fornecedor (4) | string | 15 | opcional | Código do fornecedor no Tiny |
| produtos[].produto.codigo_pelo_fornecedor | string | 20 | opcional | Código do produto pelo fornecedor |
| produtos[].produto.unidade_por_caixa | string | 3 | opcional | Ítens por embalagem |
| produtos[].produto.preco_custo (3) | decimal | - | opcional | Preço de custo do produto |
| produtos[].produto.situacao | string | 1 | obrigatório | Situação do produto "A" - Ativo, "I" - Inativo |
| produtos[].produto.tipo | string | 1 | obrigatório | Indica se é produto("P") ou serviço("S") |
| produtos[].produto.classe_ipi | string | 5 | opcional | Somente para bebidas e cigarros, classe conforme Tabela Classe de enquadramento do IPI |
| produtos[].produto.valor_ipi_fixo (3) | decimal | - | opcional | Valor IPI fixo, informar somente em produtos com tributação específica |
| produtos[].produto.cod_lista_servicos | string | 5 | opcional | Código conforme Tabela Lista de Serviços |
| produtos[].produto.descricao_complementar | text | - | opcional | Descrição complementar, campo exibido em propostas comerciais e pedidos de venda |
| produtos[].produto.obs | text | - | opcional | Observações gerais sobre o produto. |
| produtos[].produto.garantia | text | 20 | opcional | Garantia do produto. |
| produtos[].produto.cest | text | 9 | opcional | Código CEST do produto. |
| produtos[].produto.dias_preparacao | int | 9 | opcional | Quantidade dias corridos você demora para disponibilizar o produto. |
| produtos[].produto.estrutura[] | list | opcional | Lista dos itens da estrutura do produto | |
| produtos[].produto.estrutura[].item | object | opcional | Elemento utilizado para representar um item da estrutura | |
| produtos[].produto.estrutura[].item.id_produto (1) | int | opcional | Número de identificação do produto no Tiny | |
| produtos[].produto.estrutura[].item.codigo (1) | string | 60 | opcional | Código do Produto |
| produtos[].produto.estrutura[].item.descricao (1) | string | 120 | obrigatório | Descrição do Produto |
| produtos[].produto.estrutura[].item.quantidade | decimal | opcional | Quantidade do item na estrutura do produto | |
| produtos[].produto.etapas[] | list | opcional | Lista das estapas de produção do produto | |
| produtos[].produto.etapas[].etapa | - | opcional | Elemento utilizado para representar uma etapa de produção | |
| produtos[].produto.etapas[].etapa.nome | string | 50 | opcional | Nome da etapa de produção |
| produtos[].produto.marca | string | - | opcional | Marca do produto |
| produtos[].produto.tipo_embalagem (5) | int | - | opcional | Tipo da embalagem do produto |
| produtos[].produto.altura_embalagem (3) | decimal | - | opcional | Altura da embalagem do produto em cm |
| produtos[].produto.largura_embalagem (3) | decimal | - | opcional | Largura da embalagem do produto em cm |
| produtos[].produto.comprimento_embalagem (3) | decimal | - | opcional | Comprimento da embalagem do produto em cm |
| produtos[].produto.diametro_embalagem (3) | decimal | - | opcional | Diâmetro da embalagem do produto em cm |
| produtos[].produto.categoria (6) | string | - | opcional | Categoria do produto |
| produtos[].produto.anexos[] | list | - | opcional | Lista contendo imagens e anexos do produto. |
| produtos[].produto.anexos[].anexo | string | - | opcional | URL de acesso ao anexo / imagem do produto. |
| produtos[].produto.imagens_externas[] | list | - | opcional [0..n] | Lista contendo as imagens externas do produto. |
| produtos[].produto.imagens_externas[].imagem_externa | object | - | opcional | Elemento utilizado para representar uma imagem externa. |
| produtos[].produto.imagens_externas[].imagem_externa.url | string | - | obrigatório | URL da imagem externa. |
| produtos[].produto.classe_produto (7) | string | 1 | opcional | Classificação do produto. |
| produtos[].produto.kit[] (8) | list | - | condicional [0..n] | Lista contendo os itens do kit do produto. |
| produtos[].produto.kit[].item | object | - | opcional | Elemento utilizado para representar um item do kit. |
| produtos[].produto.kit[].item.id_produto | int | - | obrigatório | Número de identificação do produto no Tiny. |
| produtos[].produto.kit[].item.quantidade | decimal | - | obrigatório | Quantidade do produto dentro do kit. |
| produtos[].produto.grade[] (10)(11) | array | - | opcional | Grade da variação. |
| produtos[].produto.variacoes[] (9) | list | - | opcional [0..n] | Lista contendo as variações do produto. |
| produtos[].produto.variacoes[].variacao | object | - | opcional | Elemento utilizado para representar uma variação. |
| produtos[].produto.variacoes[].variacao.id | int | - | opcional | Número de identificação da variação no Tiny. |
| produtos[].produto.variacoes[].variacao.codigo | string | - | opcional | Código da variação. |
| produtos[].produto.variacoes[].variacao.preco | decimal | - | opcional | Preço da variação. |
| produtos[].produto.variacoes[].variacao.preco_promocional (3) (16) | decimal | - | opcional | Preço promocional da variação. |
| produtos[].produto.variacoes[].variacao.grade[] (10) | array | - | opcional | Grade da variação. |
| produtos[].produto.variacoes[].variacao.mapeamentos[] (13) | array | - | opcional [0..n] | Mapeamentos da variação com o e-commerce. |
| produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento | object | - | opcional | Elemento utilizado para representar um mapeamento. |
| produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.idEcommerce | int | - | opcional (14) | 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.urlProduto | string | - | opcional | URL do produto no e-commerce. |
| produtos[].produto.variacoes[].variacao.mapeamentos[].mapeamento.urlImagem | string | - | opcional | URL da imagem principal do produto no e-commerce. |
| produtos[].produto.tags[] (12) | array | - | opcional | Tags do produto. |
| produtos[].produto.seo.seo_title | string | 120 | opcional | Título do produto que será exibido nos resultados da busca no Google. |
| produtos[].produto.seo.seo_keywords | string | 255 | opcional | Utilizado para SEO ou metadados que ajudam a descrever um produto, valores separados por vírgula. |
| produtos[].produto.seo.link_video | string | 100 | opcional | link do vídeo. |
| produtos[].produto.seo.seo_description | string | 255 | opcional | Descrição exibida abaixo do título nos resultados da busca no Google. |
| produtos[].produto.seo.slug | text | - | opcional | Utilizado para identificação legível no link do produto no e-commerce. |
| produtos[].produto.mapeamentos[] (15) | array | - | opcional [0..n] | Mapeamentos do produto com o e-commerce. |
| produtos[].produto.mapeamentos[].mapeamento | object | - | opcional | Elemento utilizado para representar um mapeamento. |
| produtos[].produto.mapeamentos[].mapeamento.idEcommerce | int | - | opcional (14) | Identificador do e-commerce. |
| produtos[].produto.mapeamentos[].mapeamento.skuMapeamento | string | - | obrigatório | Identificador do mapeamento no e-commerce. |
| produtos[].produto.mapeamentos[].mapeamento.urlProduto | string | - | opcional | URL do produto no e-commerce. |
| produtos[].produto.mapeamentos[].mapeamento.urlImagem | string | - | opcional | URL da imagem principal do produto no e-commerce. |
(1) - Estes campos são utilizados para pesquisar o produto cadastrado, na composição somente podem ser utilizados produtos previamente cadastrados.
(2) - Estes campos são utilizados para localizar o produto que será alterado, a ordem de busca é id, codigo (caso informado), nome.
(3) - Estes campos utilizam “.” (ponto) como separador de decimais, exemplo "5.25".
(4) - Estes campos são utilizados para vincular o fornecedor ao produto, este vínculo pode ser feito por qualquer um desses dois campos, ou seja, pode ser informado somente idfornecedor ou codigofornecedor. Caso seja informado algum valor nestes campos, o fornecedor deve estar cadastrado no Tiny.
(5) - Os valores possíveis para este campo são: 1 (Envelope), 2 (Pacote / Caixa) ou 3 (Rolo / Cilindro).
(6) - Este campo espera a árvore de categorias do produto, utilizando o separador ">>", exemplo, "Categoria pai >> Categoria filha".
(7) - Este campo pode ter os valores: S (Simples), K (Kit), V (Com variações), F (Fabricado), M (Matéria-prima). O padrão é 'S'. Para produtos cadastrados como 'Com variações' esse campo é desconsiderado (não há alteração).
(8) - Este campo será obrigatório se o campo classe_produto for igual a 'K'.
(9) - Este campo só será considerado se o campo classe_produto for igual a 'V'.
(10) - 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).
(11) - Este campo só será considerado se o produto for uma variação e já estiver cadastrado no sistema.
(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á considerado mediante envio de um Developer-Id válido no header da requisição. Caso informado um array vazio, os mapeamentos da variação serão excluídos, para que esse campo seja ignorado não o envie.
(14) - Esse campo será obrigatório caso a conta possua mais de 1 integração ativa com o e-commerce do Developer-Id.
(15) - 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. Caso informado um array vazio, os mapeamentos do produto serão excluídos, para que esse campo seja ignorado não o envie.
(16) - Este campo só será considerado se empresa tiver a extensão Preço promocional instalada.
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 | - | obrigatório | 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.registros[] (2) | list | - | condicional | Lista de resultados da pesquisa |
| retorno.registros[].registro (2) | object | - | condicional | Elemento utilizado para representar um Produto. |
| retorno.registros[].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada produto. |
| retorno.registros[].registro.status | string | - | condicional | Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
| retorno.registros[].registro.codigo_erro | int | - | condicional | Conforme tabela "Códigos de erro" |
| retorno.registros[].registro.erros[] (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
| retorno.registros[].registro.erros[].erro | string | - | condicional | Mensagem contendo a descrição do erro |
| retorno.registros[].registro.id | int | - | condicional | Número de identificação do Produto no Tiny |
| retorno.registros[].registro.variacoes (4) | list | - | condicional | Lista com informações das variações que foram enviadas. |
| retorno.registros[].registro.variacoes[].variacao | object | - | condicional | Elemento que representa uma variação. |
| retorno.registros[].registro.variacoes[].variacao.id | int | - | condicional | Identificador da variação. |
(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) - Estes campos somente serão informados caso o retorno contenha erros.
(4) - Estes campos somente estarão presentes se forem enviadas variações.
Exemplos do parâmetro produto
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/produto.alterar.php';
$token = 'coloque aqui a sua chave da api';
$produto = '<produtos>...</produtos>';
$data = "token=$token&produto=$produto&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;
}
