Grupos de características
Como agrupar características em blocos como Dimensões ou Especificações Técnicas, e o mapa das rotas de grupos.
Um grupo de características é um título que reúne características parecidas. O grupo "Dimensões" reúne Largura, Altura, Profundidade e Peso; o grupo "Especificações Técnicas" reúne Voltagem e Eficiência Energética. Na página do produto e no cadastro, as características aparecem organizadas por grupo, o que deixa a ficha técnica legível quando há dezenas de atributos.
Um grupo é guardado como uma característica de tipo group, e por isso aparece também em Listar características. Esta seção mostra as rotas dedicadas, que cuidam do tipo para você.
Como funciona
- Crie o grupo
Criar grupo com um nome. O tipo é fixado em
grouppela rota; você não precisa enviarfeature_type. - Crie as características dentro dele
Em Criar característica, envie
group_idcom oiddo grupo. - Consulte os filhos
Para listar o conteúdo de um grupo, use
GET /api/v1/admin/features?group_id=<id do grupo>(Listar características).
Conceitos-chave
O que muda entre grupo e característica
| Grupo | Característica | |
|---|---|---|
feature_type | group (fixo) | qualquer outro tipo |
| Valor no produto | Não tem | Tem |
| Opções (variantes) | Não tem | Tem, nas de lista |
| Traduções | Só name | name e description |
| Nome único | Entre os grupos | Entre as características do mesmo tipo |
Status e exibição
Os campos de uma característica (status, position, display_on_product, categories_path e os demais) existem também no grupo e usam as mesmas letras: A ativa, H oculta, D desativada.
Endpoints
Todas as rotas exigem administrador com o privilégio manage_features.
| Método | Rota | O que faz | Página |
|---|---|---|---|
| GET | /api/v1/admin/feature-groups, /api/v1/admin/characteristic-groups | Lista os grupos | Listar grupos |
| GET | /api/v1/admin/feature-groups/{id}, /api/v1/admin/characteristic-groups/{id} | Consulta um grupo | Consultar grupo |
| POST | /api/v1/admin/feature-groups, /api/v1/admin/characteristic-groups | Cria um grupo | Criar grupo |
| PUT, PATCH | /api/v1/admin/feature-groups/{id}, /api/v1/admin/characteristic-groups/{id} | Altera um grupo | Alterar grupo |
| DELETE | /api/v1/admin/feature-groups/{id}, /api/v1/admin/characteristic-groups/{id} | Exclui um grupo | Excluir grupo |
Erros comuns
- Esperar
groupsna resposta. A lista de grupos devolve a chavefeatures, a mesma de uma lista de características. Cada item é um grupo. - Tentar filtrar por outro tipo. Em
/feature-groups, o parâmetrofeature_typeé sempre trocado porgroup. Para listar características comuns, use Listar características. - Achar que a consulta confere o tipo.
GET /feature-groups/{id}com o id de uma característica comum devolve essa característica, sem erro. - Mudar o tipo de um grupo. O
feature_typenão muda depois de criado; em qualquer alteração por estas rotas ele é fixado emgroup. - Repetir o nome de um grupo. O nome do grupo é único entre os grupos, sem diferenciar maiúsculas de minúsculas. A repetição volta 409.
- Contar com o 404. Um
idinexistente em alteração ou exclusão volta 500 comfeature not found, e umidque não é UUID também volta 500.