> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.erp.olist.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Incluir Grupo de Tags

> Serviço destinado a fazer inclusão de Grupos de Tags.

## Endpoint

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

## Parâmetros

| Parâmetro | Tipo   | Ocorrência  | Descrição                                   |
| --------- | ------ | ----------- | ------------------------------------------- |
| token     | string | obrigatório | Chave gerada para identificar sua empresa   |
| grupo     | object | obrigatório | Dados do grupo conforme layout especificado |
| formato   | string | obrigatório | Formato do retorno (json)                   |

### Estrutura do parâmetro "grupo"

| Campo                               | Tipo    | Tamanho | Ocorrência  | Descrição                                                          |
| ----------------------------------- | ------- | ------- | ----------- | ------------------------------------------------------------------ |
| grupos\_tag\[]                      | list    | -       | obrigatório | Elemento raiz utilizado para representar um conjunto Grupos de Tag |
| grupos\_tag\[].grupo\_tag           | object  | -       | obrigatório | Elemento utilizado para representar um Grupo de Tag                |
| grupos\_tag\[].grupo\_tag.sequencia | inteiro | -       | obrigatório | Número sequencial utilizado para identificar cada grupo de tag     |
| grupos\_tag\[].grupo\_tag.nome      | string  | 50      | obrigatório | Nome do Grupo de Tag                                               |

## Retorno

| Campo                                       | Tipo   | Tamanho | Ocorrência  | Descrição                               |
| ------------------------------------------- | ------ | ------- | ----------- | --------------------------------------- |
| retorno                                     | object | -       | obrigatório | Raiz do retorno                         |
| retorno.status\_processamento               | int    | -       | obrigatório | Conforme tabela Status de Processamento |
| retorno.status                              | string | -       | obrigatório | "OK" ou "Erro"                          |
| retorno.codigo\_erro                        | int    | -       | condicional | Conforme tabela Códigos de erro         |
| retorno.erros\[]                            | list   | -       | condicional | Lista dos erros encontrados             |
| retorno.erros\[].erro                       | string | -       | condicional | Mensagem contendo a descrição do erro   |
| retorno.registros\[]                        | list   | -       | condicional | Lista de resultados da inclusão         |
| retorno.registros\[].registro               | object | -       | condicional | Elemento representando um Grupo de Tag  |
| retorno.registros\[].registro.sequencia     | int    | -       | condicional | Número sequencial do grupo de tag       |
| retorno.registros\[].registro.status        | string | -       | condicional | "OK" ou "Erro"                          |
| retorno.registros\[].registro.codigo\_erro  | int    | -       | condicional | Conforme tabela Códigos de erro         |
| retorno.registros\[].registro.erros\[]      | list   | -       | condicional | Lista dos erros encontrados             |
| retorno.registros\[].registro.erros\[].erro | string | -       | condicional | Mensagem descrevendo o erro             |
| retorno.registros\[].registro.id            | int    | -       | condicional | ID do Grupo de Tag na Olist             |

## Exemplo de chamada

```php theme={null}
$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)

```json theme={null}
{
  "grupos_tag": [
    {
      "grupo_tag": {
        "sequencia": "1",
        "nome": "Grupo Teste 2"
      }
    },
    {
      "grupo_tag": {
        "sequencia": "2",
        "nome": "Grupo Teste 3"
      }
    }
  ]
}
```

## Exemplos de retorno

### Sucesso

```json theme={null}
{
  "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

```json theme={null}
{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [
      {
        "erro": "token invalido"
      }
    ]
  }
}
```

### Erro - Duplicidade

```json theme={null}
{
  "retorno": {
    "status_processamento": 2,
    "status": "Erro",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "Erro",
          "codigo_erro": "30",
          "erros": [
            {
              "erro": "Registro em duplicidade"
            }
          ]
        }
      }
    ]
  }
}
```