Skip to main content

Endpoint

POST https://api.tiny.com.br/api2/produto.incluir.php

Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
produtoobjectobrigatórioDados do produto conforme layout especificado
formatostringobrigatórioFormato do retorno (json)

Estrutura do parâmetro “produto”

CampoTipoTamanhoOcorrênciaDescrição
produtos[]list-obrigatórioConjunto de Produtos
produtos[].produto.sequenciainteiro-obrigatórioNúmero sequencial para identificar cada produto
produtos[].produto.nomestring120obrigatórioNome do produto
produtos[].produto.codigostring30opcionalCódigo do produto
produtos[].produto.unidadestring3obrigatórioUnidade do produto
produtos[].produto.precodecimal-obrigatórioPreço de venda do produto
produtos[].produto.preco_promocionaldecimal-opcionalPreço promocional do produto
produtos[].produto.ncmstring10opcionalNCM do produto
produtos[].produto.origemstring1obrigatórioCódigo conforme Tabela Origem
produtos[].produto.gtinstring14opcionalGTIN/EAN do produto
produtos[].produto.gtin_embalagemstring14opcionalGTIN/EAN da embalagem do produto
produtos[].produto.localizacaostring50condicionalLocalização física no estoque
produtos[].produto.peso_liquidodecimal-opcionalPeso líquido do produto (Kg)
produtos[].produto.peso_brutodecimal-opcionalPeso bruto do produto (Kg)
produtos[].produto.estoque_minimodecimal-opcionalQuantidade mínima do produto no estoque
produtos[].produto.estoque_maximodecimal-opcionalQuantidade máxima do produto no estoque
produtos[].produto.estoque_atualdecimal-opcionalQuantidade no estoque
produtos[].produto.id_fornecedorint-opcionalIdentificação do fornecedor na Olist
produtos[].produto.codigo_fornecedorstring15opcionalCódigo do fornecedor na Olist
produtos[].produto.codigo_pelo_fornecedorstring20opcionalCódigo do produto pelo fornecedor
produtos[].produto.unidade_por_caixastring3opcionalÍtens por embalagem
produtos[].produto.preco_custodecimal-opcionalPreço de custo do produto
produtos[].produto.situacaostring1obrigatórioSituação: “A” (Ativo) ou “I” (Inativo)
produtos[].produto.tipostring1obrigatório”P” (Produto) ou “S” (Serviço)
produtos[].produto.classe_ipistring5opcionalClasse para bebidas/cigarros conforme tabela
produtos[].produto.valor_ipi_fixodecimal-opcionalValor IPI fixo para tributação específica
produtos[].produto.cod_lista_servicosstring5opcionalCódigo conforme Tabela Lista de Serviços
produtos[].produto.descricao_complementartext-opcionalDescrição complementar para propostas/pedidos
produtos[].produto.obstext-opcionalObservações gerais sobre o produto
produtos[].produto.garantiatext20opcionalGarantia do produto
produtos[].produto.cesttext9opcionalCódigo CEST do produto
produtos[].produto.codigo_anvisatext13obrigatório para medicamentosCódigo do produto na ANVISA
produtos[].produto.valor_maxdecimal-opcionalPreço máximo para o consumidor
produtos[].produto.motivo_isencaotext255opcionalMotivo de isenção da ANVISA
produtos[].produto.dias_preparacaoint9opcionalQuantidade dias corridos para disponibilizar
produtos[].produto.marcastring-opcionalMarca do produto
produtos[].produto.tipo_embalagemint-opcionalTipo embalagem: 1 (Envelope), 2 (Caixa), 3 (Rolo)
produtos[].produto.altura_embalagemdecimal-opcionalAltura da embalagem em cm
produtos[].produto.largura_embalagemdecimal-opcionalLargura da embalagem em cm
produtos[].produto.comprimento_embalagemdecimal-opcionalComprimento da embalagem em cm
produtos[].produto.diametro_embalagemdecimal-opcionalDiâmetro da embalagem em cm
produtos[].produto.categoriastring-opcionalÁrvore de categorias usando separador ”>>“
produtos[].produto.anexos[]list-opcionalLista contendo imagens e anexos
produtos[].produto.anexos[].anexostring-opcionalURL de acesso ao anexo/imagem
produtos[].produto.imagens_externas[]list-opcionalLista de imagens externas do produto
produtos[].produto.imagens_externas[].imagem_externa.urlstring-obrigatórioURL da imagem externa
produtos[].produto.classe_produtostring1opcionalClassificação: S/K/V/F/M (padrão: S)
produtos[].produto.kit[]list-opcionalLista contendo itens do kit
produtos[].produto.kit[].item.id_produtoint-obrigatórioID do produto na Olist
produtos[].produto.kit[].item.quantidadedecimal-obrigatórioQuantidade do produto dentro do kit
produtos[].produto.variacoes[]list-opcionalLista contendo variações do produto
produtos[].produto.variacoes[].variacao.codigostring-opcionalCódigo da variação
produtos[].produto.variacoes[].variacao.precodecimal-opcionalPreço da variação
produtos[].produto.variacoes[].variacao.preco_promocionaldecimal-opcionalPreço promocional da variação
produtos[].produto.variacoes[].variacao.estoque_atualdecimal-opcionalQuantidade em estoque da variação
produtos[].produto.variacoes[].variacao.grade[]array-opcionalGrade da variação (chave-valor)
produtos[].produto.tags[]array-opcionalTags do produto (IDs pré-cadastradas)
produtos[].produto.seo.seo_titlestring120opcionalTítulo para resultados busca Google
produtos[].produto.seo.seo_keywordsstring255opcionalPalavras-chave SEO (separadas por vírgula)
produtos[].produto.seo.link_videostring100opcionalLink do vídeo
produtos[].produto.seo.seo_descriptionstring255opcionalDescrição para resultados busca Google
produtos[].produto.seo.slugtext-opcionalIdentificação legível no link do produto
Campos com valores decimais utilizam ”.” (ponto) como separador (ex: “5.25”).
Campo categoria espera árvore de categorias usando separador ”>>” (ex: “Categoria pai >> Categoria filha”).
Campo classe_produto: S (Simples), K (Kit), V (Com variações), F (Fabricado), M (Matéria-prima). Padrão: ‘S’.
Campo kit considerado apenas se classe_produto = ‘K’.
Campo variacoes considerado apenas se classe_produto = ‘V’.
Array grade onde chave é tipo variação (ex: Tamanho, Cor) e valor é valor da variação (ex: GG, Branco).
Campo preco_promocional considerado apenas com extensão “Preço promocional” instalada.

Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-obrigatórioConforme tabela “Códigos de erro”
retorno.erros[]list-condicionalLista dos erros encontrados
retorno.erros[].errostring-condicionalDescrição do erro
retorno.registros[]list-condicionalLista de resultados
retorno.registros[].registroobject-condicionalRepresenta um Produto
retorno.registros[].registro.sequenciaint-condicionalNúmero sequencial do produto
retorno.registros[].registro.statusstring-condicional”OK” ou “Erro”
retorno.registros[].registro.codigo_erroint-condicionalCódigo do erro
retorno.registros[].registro.erros[]list-condicionalLista dos erros
retorno.registros[].registro.erros[].errostring-condicionalDescrição do erro
retorno.registros[].registro.idint-condicionalID do Produto na Olist
retorno.registros[].registro.variacoeslist-condicionalLista das variações enviadas
retorno.registros[].registro.variacoes[].variacaoobject-condicionalRepresenta uma variação
retorno.registros[].registro.variacoes[].variacao.idint-condicionalID da variação

Exemplo de chamada

$url = 'https://api.tiny.com.br/api2/produto.incluir.php';
$token = 'coloque aqui a sua chave da api';
$produto = '<produtos>...</produtos>';
$data = "token=$token&produto=$produto&formato=JSON";

enviarREST($url, $data);

Exemplos de retorno

Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "OK",
          "id": "49644544"
        }
      },
      {
        "registro": {
          "sequencia": "2",
          "status": "OK",
          "id": "49644545",
          "variacoes": [
            {
              "variacao": {
                "id": "31232333"
              }
            },
            {
              "variacao": {
                "id": "43234442"
              }
            }
          ]
        }
      }
    ]
  }
}

Erro - Autenticação

{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}

Erro - Duplicidade

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "30",
          "erros": [
            {
              "erro": "Registro em duplicidade"
            }
          ]
        }
      }
    ]
  }
}