VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Guia rápido

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ê.

Pontos-chave
  • Um grupo é uma característica com feature_type igual a group. As rotas /feature-groups e /characteristic-groups fazem o mesmo trabalho e são apelidos uma da outra: feature é o nome da plataforma e da API, characteristic (característica) é o nome em português do painel.
  • Um grupo não guarda valor. Quem guarda valor são as características filhas, que apontam para o grupo em group_id.
  • Ao criar uma característica com group_id, ela herda as categorias do grupo (categories_path). Quer que um bloco inteiro valha só para "Calçados"? Defina categories_path no grupo antes de criar as filhas.
  • Um grupo só tem nome traduzido por idioma, sem descrição.
  • Excluir um grupo não exclui as características dentro dele: elas ficam sem grupo.

Como funciona

Criar o grupo→Criar as características com group_id→Listar por group_id
  1. Crie o grupo

    Criar grupo com um nome. O tipo é fixado em group pela rota; você não precisa enviar feature_type.

  2. Crie as características dentro dele

    Em Criar característica, envie group_id com o id do grupo.

  3. 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

GrupoCaracterística
feature_typegroup (fixo)qualquer outro tipo
Valor no produtoNão temTem
Opções (variantes)Não temTem, nas de lista
TraduçõesSó namename e description
Nome únicoEntre os gruposEntre 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étodoRotaO que fazPágina
GET/api/v1/admin/feature-groups, /api/v1/admin/characteristic-groupsLista os gruposListar grupos
GET/api/v1/admin/feature-groups/{id}, /api/v1/admin/characteristic-groups/{id}Consulta um grupoConsultar grupo
POST/api/v1/admin/feature-groups, /api/v1/admin/characteristic-groupsCria um grupoCriar grupo
PUT, PATCH/api/v1/admin/feature-groups/{id}, /api/v1/admin/characteristic-groups/{id}Altera um grupoAlterar grupo
DELETE/api/v1/admin/feature-groups/{id}, /api/v1/admin/characteristic-groups/{id}Exclui um grupoExcluir grupo

Erros comuns

  1. Esperar groups na resposta. A lista de grupos devolve a chave features, a mesma de uma lista de características. Cada item é um grupo.
  2. Tentar filtrar por outro tipo. Em /feature-groups, o parâmetro feature_type é sempre trocado por group. Para listar características comuns, use Listar características.
  3. 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.
  4. Mudar o tipo de um grupo. O feature_type não muda depois de criado; em qualquer alteração por estas rotas ele é fixado em group.
  5. 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.
  6. Contar com o 404. Um id inexistente em alteração ou exclusão volta 500 com feature not found, e um id que não é UUID também volta 500.

Próximos passos

Criar grupo
Cadastre um bloco como Dimensões.
Criar característica
Crie características dentro do grupo com group_id.
Listar características
Liste o conteúdo de um grupo com group_id.
Anterior
Características padrão
Próxima
Listar grupos
Nesta página
  • Como funciona
  • Conceitos-chave
  • O que muda entre grupo e característica
  • Status e exibição
  • Endpoints
  • Erros comuns
  • Próximos passos