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

Características padrão

Cadastra o conjunto básico de características e grupos do varejo brasileiro (cor, tamanho, marca, peso) e liga os filtros padrão da vitrine.

Uma loja nova costuma começar com as mesmas necessidades: filtrar por cor, tamanho, marca e material, mostrar peso e dimensões, agrupar tudo em blocos como "Especificações Técnicas". Esta operação cadastra esse conjunto pronto, para você não precisar criar uma a uma.

Ela é idempotente: pode ser chamada várias vezes sem duplicar nada. O que já existe com o mesmo código ou o mesmo nome (sem diferenciar maiúsculas de minúsculas) é deixado como está; só o que falta é criado, inclusive opções que faltam em características que já existem. Lojas criadas hoje já recebem esse conjunto no cadastro; a rota serve para lojas mais antigas ou para repor o que foi apagado.

POST/api/v1/admin/features/seed-defaultsAdmin

Cadastrar as características padrão da loja

Não recebe corpo. Exige o privilégio manage_features.

O conjunto inclui os grupos Descrição Geral, Especificações Técnicas, Dimensões, Materiais e Composição e Garantia e Suporte, e as características Cor, Tamanho, Numeração (Calçados), Material, Peso, Marca, Largura, Altura, Profundidade, Modelo, Gênero, Faixa Etária, Garantia, País de Origem, Voltagem e Eficiência Energética, com as opções das de lista. A rota também completa as configurações dos filtros da vitrine (preço, estoque, frete grátis e vendedor ligados), sem sobrescrever o que a loja já definiu.

Exemplo de requisição

bash
curl -X POST "$BASE_URL/api/v1/admin/features/seed-defaults" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Conjunto padrão aplicado
json
{
  "groups_created": 0,
  "features_created": 0,
  "variants_created": 0,
  "filter_settings_applied": false,
  "skipped": false,
  "message": "Default features seeded: 0 groups, 0 features, 0 variants (existing left untouched); filter settings applied=false"
}

Este é o resultado numa loja que já tinha tudo. Numa loja vazia, os contadores trazem o que foi criado.

Campos da resposta

groups_createdinteger
Grupos criados nesta chamada.
features_createdinteger
Características criadas.
variants_createdinteger
Opções criadas.
filter_settings_appliedboolean
true quando alguma configuração de filtro da vitrine foi gravada ou completada.
skippedboolean
Reservado. Hoje vem false.
messagestring
Resumo em inglês, com os contadores e, se houver, o primeiro aviso.
warningsarray
Até 10 avisos, um por linha que não pôde ser criada. Ausente quando não houve problema.

Erros

StatusQuandoCorpo
401Sem credenciais ou token expirado{"error":"missing authorization header"}
403Sem o privilégio manage_features{"error":"insufficient privileges","required":"manage_features"}
500Nada foi criado e todos os passos deram aviso (por exemplo, a loja ainda não recebeu uma atualização do banco), ou a loja não foi resolvida{"error":"failed to seed default features","detail":"<primeiro aviso>"}
Resposta 200 não quer dizer que tudo foi criado

Se só parte das linhas falhar, a resposta é 200 e os problemas ficam em warnings. Confira esse campo, e os contadores, antes de considerar o cadastro completo.

Veja também

  • Criar característica
  • Grupos de características
  • Listar características
Anterior
Sinônimos de valores
Próxima
Grupos de características
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também