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

Consultar categoria

Retorna uma categoria pelo id, com todos os campos, inclusive as versões por idioma.

Use esta operação quando você já sabe qual categoria quer: abrir a ficha de uma categoria no seu sistema, conferir o status antes de alterar ou ler os textos de cada idioma para editá-los. Para varrer várias categorias, prefira Listar categorias.

A consulta por id devolve a categoria em qualquer status, inclusive na lixeira (T). A lista não inclui a lixeira, mas o GET por id inclui, então confira o status antes de tratar o registro como ativo.

GET/api/v1/admin/categories/{id}Admin

Consulta uma categoria

Autenticação: Authorization: Bearer <token> de um administrador com o privilégio view_catalog, manage_catalog ou manage_categories.

Parâmetros de caminho

iduuidobrigatório
Id da categoria. Um valor que não é UUID responde 404, não 500.

Parâmetros de consulta

langstring
Código do idioma (pt-BR, en...). Devolve name, description e SEO naquele idioma, quando existem.
include_descriptionsstring
1
Com o valor 1, a resposta muda de formato: vem {"category": {...}, "descriptions": {...}}, com o texto de todos os idiomas em descriptions. É o formato usado pelo painel para preencher as abas de idioma.

Exemplo de requisição

bash
curl "$BASE_URL/api/v1/admin/categories/345ac33e-4dcd-4d60-bedf-a2c2d47897d9?include_descriptions=1" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Categoria retornada
json
{
  "id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
  "name": "Escritório",
  "slug": "escritorio",
  "description": "",
  "position": 0,
  "status": "A",
  "path": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
  "depth": 0,
  "product_count": 2,
  "created_at": "2026-09-09T13:11:20.906519Z",
  "updated_at": "2026-09-09T13:11:20.906519Z",
  "category_id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
  "category": "Escritório",
  "seo_name": "escritorio",
  "timestamp": 1788959480,
  "updated_timestamp": 1788959480
}
200Com include_descriptions=1
json
{
  "category": {
    "id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
    "name": "Escritório",
    "slug": "escritorio",
    "status": "A"
  },
  "descriptions": {
    "pt-BR": { "lang_code": "pt-BR", "name": "Escritório", "description": "", "seo_title": "", "seo_description": "" },
    "es": { "lang_code": "es", "name": "Escritório", "description": "", "seo_title": "", "seo_description": "" }
  }
}

Os campos do objeto da categoria são os de Listar categorias (id, parent_id, name, slug, status, path, depth, image_url, seo_title e os demais). Em descriptions, cada chave é um código de idioma e o valor tem lang_code, name, description, seo_title e seo_description.

Erros

StatusQuandoCorpo
401Sem credenciais ou token expirado{"error":"invalid or expired token"}
403Sem privilégio de catálogo{"error":"insufficient privileges","privilege_required_any":["manage_categories","view_catalog","manage_catalog"]}
404Categoria não existe{"error":"category not found"}
O contador de produtos varia conforme a rota

O product_count de uma consulta por id pode diferir do valor da mesma categoria em Listar categorias: as duas rotas contam de formas diferentes. Não use esse campo como número exato de produtos. Para o total real, liste os produtos (Listar produtos, com o filtro category_id).

Veja também

  • Listar categorias
  • Alterar categoria
  • SEO da categoria
  • Listar produtos
Anterior
Listar categorias
Próxima
Criar categoria
Nesta página
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também