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

Categorias permitidas do seller

Define em quais categorias de produto um seller pode vender, quando a loja usa o recurso de categorias por seller.

Algumas lojas limitam onde cada seller pode vender: um seller de eletrônicos não cadastra produtos em "Alimentos". Essa lista de categorias permitidas só vale quando o recurso categories_by_vendor está ligado nas configurações da loja. Com o recurso desligado, as rotas respondem 404 categories_by_vendor feature is not enabled. O privilégio exigido é manage_vendor_categories ou manage_vendors.

Defeito conhecido: as quatro rotas respondem 400

Na verificação feita para este manual, as quatro rotas desta página devolveram 400 {"error":"vendor id is required"} mesmo com um UUID de seller válido na URL. O caminho usa o parâmetro vendorId, e o tratamento lê outro nome. Enquanto isso não for corrigido, o formato abaixo vem do código e não pôde ser confirmado ao vivo. Para ajustar as categorias de um seller, use o painel do administrador.

Ler as categorias do seller

GET/api/v1/admin/vendors/{vendorId}/categoriesAdmin

Lista as categorias em que o seller pode vender

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.

A resposta esperada é uma lista de vínculos:

200Categorias do seller
json
[
  {
    "id": "3a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
    "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
    "category_id": "ae6f8f8b-7cbe-4725-84fa-247cce138143",
    "created_at": "2026-10-01T12:00:00Z",
    "category_name": "Eletrônicos",
    "category_slug": "eletronicos"
  }
]

Campos da resposta

iduuid
Id do vínculo.
vendor_iduuid
Seller.
category_iduuid
Categoria permitida.
category_namestring
Nome da categoria.
category_slugstring
Slug da categoria.
created_atstring
Quando foi permitida (RFC 3339).

Definir todas as categorias

Substitui a lista inteira: apaga os vínculos atuais e grava os enviados, numa única transação. Devolve a lista nova.

PUT/api/v1/admin/vendors/{vendorId}/categoriesAdmin

Substitui as categorias permitidas de um seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.

Corpo da requisição

category_idsarrayobrigatório
Ids (UUID) das categorias permitidas. Lista vazia remove todas as restrições positivas do seller.

Permitir uma categoria

POST/api/v1/admin/vendors/{vendorId}/categories/{categoryId}Admin

Permite uma categoria para o seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
categoryIduuidobrigatório
Id da categoria.

Responde 201 com o vínculo criado.

Retirar uma categoria

DELETE/api/v1/admin/vendors/{vendorId}/categories/{categoryId}Admin

Retira uma categoria do seller

Parâmetros de caminho

vendorIduuidobrigatório
Id do seller.
categoryIduuidobrigatório
Id da categoria.
200Retirada
json
{ "message": "vendor category removed" }

Erros

StatusQuandoCorpo de exemplo
400Hoje, em toda chamada (defeito descrito acima).{"error":"vendor id is required"}
400Corpo do PUT não é JSON.{"error":"invalid request body","detail":"..."}
400Falha ao permitir a categoria (por exemplo, categoria inexistente).{"error":"failed to add vendor category","detail":"..."}
404Recurso categories_by_vendor desligado na loja.{"error":"categories_by_vendor feature is not enabled"}
500Falha ao gravar ou retirar.{"error":"failed to set vendor categories","detail":"..."}
401 / 403Sem token ou sem privilégio.{"error":"missing authorization header"}

Veja também

  • Privilégios do seller
  • Visão geral
Anterior
Configurações do seller
Próxima
Privilégios do seller
Nesta página
  • Ler as categorias do seller
  • Definir todas as categorias
  • Permitir uma categoria
  • Retirar uma categoria
  • Erros
  • Veja também