Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
idintobrigatórioNúmero de identificação do produto na Olist
formatostringobrigatórioFormato do retorno (json)

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatórioStatus do retorno: “OK” ou “Erro”
retorno.codigo_erroint-condicionalConforme tabela “Códigos de erro”
retorno.erros[]list-condicionalLista dos erros encontrados
retorno.erros[].errostring-condicionalMensagem descritiva do erro
retorno.produtoobject-condicionalElemento representando um produto
retorno.produto.idint-condicionalNúmero de identificação do produto
retorno.produto.nomestring120condicionalNome do produto
retorno.produto.codigostring30condicionalCódigo do produto
retorno.produto.estrutura[]list-condicionalLista de componentes do produto
retorno.produto.estrutura[].itemobject-condicionalItem da composição do produto
retorno.produto.estrutura[].item.id_componenteint-condicionalID do componente na Olist
retorno.produto.estrutura[].item.codigostring30condicionalCódigo do componente
retorno.produto.estrutura[].item.nomestring120condicionalNome do componente
retorno.produto.estrutura[].item.quantidadedecimal-condicionalQuantidade do item na composição
Valores decimais utilizam ”.” (ponto) como separador decimal, exemplo “5.25”.

​
Exemplo de chamada

curl -X POST https://api.tiny.com.br/api2/produto.obter.estrutura.php \
  -d "token=SUA_CHAVE_API&id=xxxxx&formato=JSON"

​
Exemplos de retorno

​
Sucesso

{
  "retorno": {
    "status_processamento": "3",
    "status": "OK",
    "produto": {
      "id": "46829062",
      "codigo": "123",
      "nome": "produto teste",
      "estrutura": [
        {
          "item": {
            "id_componente": "626414",
            "codigo": "1",
            "nome": "Caderno",
            "quantidade": "1"
          }
        },
        {
          "item": {
            "id_componente": "11086140",
            "codigo": "223435780",
            "nome": "Caneta 001",
            "quantidade": "2"
          }
        }
      ]
    }
  }
}

​
Erro - Token inválido

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

​
Erro - Produto não localizado

{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "codigo_erro": 32,
    "erros": [
      {
        "erro": "Produto não localizado"
      }
    ]
  }
}