API atual/Guia rápido/Grupos de características

Consultar grupo

Retorna um grupo de características pelo id e, se pedido, o nome dele em cada idioma da loja.

Use esta operação para abrir um grupo, por exemplo na tela de edição, e para ler o nome dele em todos os idiomas. Ela devolve o próprio grupo; as características filhas não vêm junto (use Listar características com group_id).

GET/api/v1/admin/feature-groups/{id}Admin

Consultar um grupo de características

Exige o privilégio manage_features.

Parâmetros de caminho

iduuidobrigatório

Id do grupo.

Parâmetros de consulta

include_descriptionsstring

1

Com 1, a resposta vira {"feature": {...}, "descriptions": {...}}, com o nome do grupo em cada idioma da loja.

GET/api/v1/admin/characteristic-groups/{id}Admin

Apelido em português: consultar um grupo de características

Apelido de /api/v1/admin/feature-groups/{id}: mesmo parâmetro e mesma resposta.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/admin/feature-groups/734326ad-8530-43ce-966e-6ec26f0f26de?include_descriptions=1" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Grupo com traduções

json

{
  "feature": {
    "id": "734326ad-8530-43ce-966e-6ec26f0f26de",
    "name": "Dimensões",
    "code": "dimensions",
    "feature_type": "group",
    "description": "Largura, altura, profundidade e peso",
    "purpose": "",
    "prefix": "",
    "suffix": "",
    "categories_path": "",
    "display_on_product": true,
    "display_on_catalog": false,
    "filterable": false,
    "comparable": true,
    "position": 30,
    "status": "A",
    "created_at": "2026-04-29T19:57:53.005899Z",
    "updated_at": "2026-04-29T19:57:53.005899Z",
    "feature_id": "734326ad-8530-43ce-966e-6ec26f0f26de",
    "feature": "Dimensões",
    "timestamp": 1777492673,
    "updated_timestamp": 1777492673
  },
  "descriptions": {
    "pt-BR": { "lang_code": "pt-BR", "name": "Dimensões", "description": "" },
    "en": { "lang_code": "en", "name": "Dimensões", "description": "" }
  }
}

Sem include_descriptions, o corpo é só o objeto do grupo (o conteúdo de feature acima).

Campos da resposta

featureobject

Só com include_descriptions=1. O grupo, com os campos descritos em Listar grupos.

descriptionsobject

Só com include_descriptions=1. Chaves são códigos de idioma; cada valor tem lang_code, name e description (sempre vazia em grupo). Um idioma que ainda não foi traduzido repete o nome do idioma padrão.

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"error":"missing authorization header"}`
403	Sem o privilégio `manage_features`	`{"error":"insufficient privileges","required":"manage_features"}`
404	Nenhum registro com esse id	`{"error":"feature not found"}`
500	`id` que não é um UUID válido	`{"error":"failed to get feature","detail":"o valor \"abc\" não é um uuid válido. Envie o identificador completo, com os 36 caracteres e os hífens. Corrija o campo e reenvie."}`

Veja também