Skip to main content

​
Endpoint

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

​
Parâmetros

ParâmetroTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
pesquisastringobrigatórioNome ou parte do nome do grupo de tags que deseja consultar
formatostringobrigatórioFormato do retorno (json)
paginaintopcionalNúmero da página (padrão: 1, lista 100 registros por página)

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioNodo raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela “Status de Processamento”
retorno.statusstring-obrigatório”OK” ou “Erro”
retorno.codigo_erroint-condicionalConforme tabela “Códigos de erro”
retorno.erros[]list-condicionalLista dos erros encontrados
retorno.erros[].errostring-condicionalMensagem com descrição do erro
retorno.paginaint-obrigatórioNúmero da página retornada
retorno.numero_paginasint-obrigatórioNúmero de páginas do retorno
retorno.registros[]list-condicionalLista de resultados da pesquisa
retorno.registros[].registroobject-condicionalElemento representando um Grupo de Tag
retorno.registros[].registro.idint-condicionalIdentificação do Grupo de Tag na Olist
retorno.registros[].registro.nomestring50condicionalNome do Grupo de Tag

​
Exemplo de chamada

$url = 'https://api.tiny.com.br/api2/grupo.tag.pesquisa.php';
$token = 'sua_chave_api';
$pesquisa = 'xxxxx';
$data = "token=$token&pesquisa=$pesquisa&formato=JSON";

enviarREST($url, $data);

​
Exemplos de retorno

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "pagina": "1",
    "numero_paginas": "1",
    "registros": [
      {
        "registro": {
          "id": "37644487",
          "nome": "Grupo Teste 2"
        }
      },
      {
        "registro": {
          "id": "37644488",
          "nome": "Grupo Teste 3"
        }
      }
    ]
  }
}

​
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"
      }
    ]
  }
}