Skip to main content

​
Endpoint

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

​
Parâmetros

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

​
Estrutura do parâmetro “grupo”

CampoTipoTamanhoOcorrênciaDescrição
grupos_tag[]list-obrigatórioElemento raiz utilizado para representar um conjunto Grupos de Tag
grupos_tag[].grupo_tagobject-obrigatórioElemento utilizado para representar um Grupo de Tag
grupos_tag[].grupo_tag.sequenciainteiro-obrigatórioNúmero sequencial utilizado para identificar cada grupo de tag
grupos_tag[].grupo_tag.nomestring50obrigatórioNome do Grupo de Tag

​
Retorno

CampoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioRaiz 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 contendo a descrição do erro
retorno.registros[]list-condicionalLista de resultados da inclusão
retorno.registros[].registroobject-condicionalElemento representando um Grupo de Tag
retorno.registros[].registro.sequenciaint-condicionalNúmero sequencial do grupo de tag
retorno.registros[].registro.statusstring-condicional”OK” ou “Erro”
retorno.registros[].registro.codigo_erroint-condicionalConforme tabela Códigos de erro
retorno.registros[].registro.erros[]list-condicionalLista dos erros encontrados
retorno.registros[].registro.erros[].errostring-condicionalMensagem descrevendo o erro
retorno.registros[].registro.idint-condicionalID do Grupo de Tag na Olist

​
Exemplo de chamada

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

enviarREST($url, $data);

​
Exemplo de entrada (JSON)

{
  "grupos_tag": [
    {
      "grupo_tag": {
        "sequencia": "1",
        "nome": "Grupo Teste 2"
      }
    },
    {
      "grupo_tag": {
        "sequencia": "2",
        "nome": "Grupo Teste 3"
      }
    }
  ]
}

​
Exemplos de retorno

​
Sucesso

{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "OK",
          "id": "37644487"
        }
      },
      {
        "registro": {
          "sequencia": "2",
          "status": "OK",
          "id": "37644488"
        }
      }
    ]
  }
}

​
Erro - Token inválido

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