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

Categorias do seller

As categorias próprias do seller, a lista de categorias liberadas pelo administrador e a ficha técnica por categoria.

Categorias organizam o catálogo em árvore (Roupas > Camisetas > Manga longa) e definem onde cada produto aparece na vitrine. No marketplace existem três coisas diferentes com o nome "categoria do seller", e confundi-las é o erro mais comum: as categorias da loja (criadas pelo administrador, que todos usam), as categorias próprias do seller (criadas e mantidas por ele) e a lista de categorias liberadas (uma permissão que o administrador dá ao seller). Esta seção cobre as duas últimas.

Pontos principais
  • GET /categories/own lista só as categorias do próprio seller; as categorias da loja não aparecem ali nem podem ser alteradas por estas rotas.
  • GET /categories (sem /own) não lista categorias: devolve a lista de categorias liberadas pelo administrador, e só existe quando a loja liga o recurso "categorias por seller".
  • A árvore tem no máximo 6 níveis (profundidade 0 a 5).
  • Excluir uma categoria que tem produtos ou subcategorias volta 409; com ?cascade=true leva tudo junto, inclusive os produtos.
  • Categoria própria excluída vai para a lixeira da loja.

Como funciona

StatusSignificado
AAtiva: aparece na vitrine.
HOculta: não aparece na vitrine.
DDesativada: continua existindo, mas fora da vitrine.
TLixeira: excluída, some das listas por 30 dias antes da remoção definitiva.

Conceitos importantes

Dono da categoria

Toda rota de categoria própria resolve o seller pelo token e só enxerga categorias dele. Uma categoria da loja, ou de outro seller, responde 404 como se não existisse. O mesmo vale para parent_id: o pai também precisa ser seu.

Quem pode chamar

As rotas de categoria própria pedem um privilégio de configurações do seller (vendor_settings ou um dos seus irmãos, como vendor_view_settings). GET /categories e check só exigem ser seller. categories/export e feature-template pedem privilégio de catálogo/importação.

Endpoints

MétodoCaminhoPara que serve
GET/api/v1/vendor/categories/ownLista as categorias que são do seller.
POST/api/v1/vendor/categoriesCria uma categoria própria.
PUT/api/v1/vendor/categories/{categoryId}Altera uma categoria própria.
DELETE/api/v1/vendor/categories/{categoryId}Exclui uma categoria própria.
GET/api/v1/vendor/categoriesLista as categorias liberadas para vender.
GET/api/v1/vendor/categories/{categoryId}/checkDiz se o seller pode vender na categoria.
GET/api/v1/vendor/categories/exportBaixa as categorias em CSV.
GET/api/v1/vendor/categories/{id}/feature-templateLê a ficha técnica da categoria.

Erros comuns

  1. Chamar GET /categories esperando a árvore. Ele devolve as categorias liberadas (e 404 se o recurso estiver desligado). Para as suas categorias use /categories/own.
  2. Usar parent_id de categoria da loja. Só o seu próprio pai é aceito; a resposta é 404 parent category not found.
  3. Repetir o nome sob o mesmo pai. Duas categorias irmãs com o mesmo nome são recusadas (volta 500 com a mensagem no detail).
  4. Passar de 6 níveis. Também volta 500 com detail.
  5. Excluir sem pensar no cascade. ?cascade=true apaga subcategorias e os produtos delas.
  6. Mandar status com palavra desconhecida. Qualquer valor fora de A, H, D, T (ou dos nomes active, hidden, disabled, deleted) vira A sem aviso.

Próximos passos

Categorias próprias
Criar, alterar e excluir a sua árvore.
Categorias liberadas
Onde o administrador deixa você vender.
Exportar e ficha técnica
CSV de categorias e atributos exigidos.
Anterior
Produtos obrigatórios
Próxima
Categorias próprias
Nesta página
  • Como funciona
  • Conceitos importantes
  • Dono da categoria
  • Quem pode chamar
  • Endpoints
  • Erros comuns
  • Próximos passos