Skip to main content

​
Endpoint

POST https://api.tiny.com.br/api2/produtos.pesquisa.php

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
formatostringobrigatórioFormato do retorno (json)
pesquisastringobrigatórioNome ou código (ou parte) do produto que deseja consultar
idTagintopcionalNúmero de identificação da tag na Olist
idListaPrecointopcionalNúmero de identificação da lista de preço (preços calculados conforme lista informada)
paginaintopcionalNúmero da página (padrão: 100 registros/página, valor padrão = 1)
gtinstringopcionalGTIN/EAN do produto
situacaostringopcionalSituação dos produtos (“A” - Ativo, “I” - Inativo, “E” - Excluído); padrão: Ativo e Inativo
dataCriacaostringopcionalData de criação do produto. Formato: dd/mm/aaaa hh:mm:ss

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatórioContém “OK” ou “Erro”
retorno.codigo_erroint-condicionalConforme tabela “Códigos de erro” (presente se status = “Erro”)
retorno.erros[]list-condicionalLista dos erros encontrados
retorno.erros[].errostring-condicionalMensagem descritiva do erro
retorno.paginaint-obrigatórioNúmero da página retornada
retorno.numero_paginasint-obrigatórioNúmero total de páginas
retorno.produtos[]list-condicionalLista de resultados (presente se status = “OK”)
retorno.produtos[].produtoobject-condicionalElemento representando um produto
retorno.produtos[].produto.idint-obrigatórioNúmero de identificação do produto
retorno.produtos[].produto.nomestring120obrigatórioNome do produto
retorno.produtos[].produto.codigostring30condicionalCódigo do produto
retorno.produtos[].produto.precodecimal-obrigatórioPreço de venda do produto
retorno.produtos[].produto.preco_promocionaldecimal-obrigatórioPreço promocional do produto
retorno.produtos[].produto.preco_custodecimal-condicionalPreço de custo do produto
retorno.produtos[].produto.preco_custo_mediodecimal-condicionalPreço médio de custo do produto
retorno.produtos[].produto.unidadestring3condicionalUnidade do produto
retorno.produtos[].produto.gtinstring14condicionalGTIN/EAN do produto
retorno.produtos[].produto.tipoVariacaostring1obrigatórioTipo de variação: “N” - Normal, “P” - Pai, “V” - Variação
retorno.produtos[].produto.localizacaostring50condicionalLocalização física no estoque
retorno.produtos[].produto.situacaostring1condicionalSituação (“A” - Ativo, “I” - Inativo, “E” - Excluído)
retorno.produtos[].produto.data_criacaostring19condicionalData de criação. Formato: dd/mm/aaaa hh:mm:ss
Campos com valores decimais utilizam ”.” (ponto) como separador de decimais, exemplo “5.25”.

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/produtos.pesquisa.php \
  -d "token=SEU_TOKEN&formato=json&pesquisa=nome_produto"

​
Exemplos de retorno

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "pagina": "1",
    "numero_paginas": "1",
    "produtos": [
      {
        "produto": {
          "id": 46829062,
          "codigo": "123",
          "nome": "produto teste",
          "preco": "1.20",
          "preco_promocional": "1.10",
          "preco_custo": "1.05",
          "preco_custo_medio": "1.02",
          "unidade": "UN",
          "tipoVariacao": "P"
        }
      },
      {
        "produto": {
          "id": 46829066,
          "codigo": "1234",
          "nome": "produto teste 2",
          "preco": "15.25",
          "preco_promocional": "13.10",
          "preco_custo": "12.75",
          "preco_custo_medio": "11.89",
          "unidade": "PC",
          "tipoVariacao": "N"
        }
      }
    ]
  }
}

​
Erro - Token inválido

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

​
Erro - Consulta sem registros

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 20,
    "erros": [
      {
        "erro": "A Consulta não retornou registros"
      }
    ]
  }
}