Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatórioStatus “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.categorias[]lista-condicionalLista de categorias
retorno.categorias[].idint-condicionalID da categoria na Olist
retorno.categorias[].descricaostring-condicionalDescrição da categoria
retorno.categorias[].nodes[]lista-condicionalLista com subcategorias

​
Exemplo de chamada

$url = 'https://api.tiny.com.br/api2/produtos.categorias.arvore.php';
$token = 'sua_chave_api';
$data = "token=$token";

$params = array('http' => array(
    'method' => 'POST',
    'content' => $data
));
$ctx = stream_context_create($params);
$fp = fopen($url, 'rb', false, $ctx);
$response = stream_get_contents($fp);

​
Exemplos de retorno

​
Sucesso - Categorias com estrutura hierárquica

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "categorias": [
      {
        "id": "440269263",
        "descricao": "Roupas",
        "nodes": [
          {"id": "440292323", "descricao": "Masculino", "nodes": []},
          {"id": "440490942", "descricao": "Feminino", "nodes": []}
        ]
      },
      {
        "id": "440430710",
        "descricao": "Teste",
        "nodes": [
          {
            "id": "440430711",
            "descricao": "Teste 1",
            "nodes": [
              {
                "id": "440430712",
                "descricao": "Teste 2",
                "nodes": [
                  {"id": "440430713", "descricao": "Teste 3", "nodes": []}
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

​
Erro - Token inválido

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

​
Erro - Sem registros

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