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.
/api/v1/admin/categories/{id}AdminConsulta 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órioParâmetros de consulta
langstringpt-BR, en...). Devolve name, description e SEO naquele idioma, quando existem.include_descriptionsstring11, 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
Resposta
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
| Status | Quando | Corpo |
|---|---|---|
| 401 | Sem credenciais ou token expirado | {"error":"invalid or expired token"} |
| 403 | Sem privilégio de catálogo | {"error":"insufficient privileges","privilege_required_any":["manage_categories","view_catalog","manage_catalog"]} |
| 404 | Categoria não existe | {"error":"category not found"} |