Consultar categoria

Retorna uma categoria pelo id, com todos os campos que a API legada devolve.

Use esta operação quando você já sabe qual categoria quer: abrir a ficha de uma categoria no seu sistema, conferir o nome, a mãe e a posição antes de alterar, ou ler o slug e a descrição. Para varrer várias categorias, prefira Listar categorias.

A consulta por id devolve a categoria em qualquer status, inclusive na lixeira. A lista não inclui a lixeira, mas o GET por id inclui. Como esta API informa sempre "status": "A", a resposta não permite saber o estado real (veja a home da seção).

GET/api/v1.0/categories/{id}Admin

Consultar uma categoria

Autenticação: HTTP Basic com e-mail:chave_de_api, ou Bearer <JWT>. A leitura aceita qualquer credencial válida da loja.

Parâmetros de caminho

idstringobrigatório

UUID da categoria ou o slug dela (o seo_name da resposta), como no contrato da Venddor 1.0. Um slug que não existe volta como erro 500 (veja os erros).

Parâmetros de consulta

category_codestring

Slug (ou UUID) da categoria. Quando enviado, vence o {id} do caminho.

GET/api/categories/{id}Admin

Consultar uma categoria (rota sem /v1.0)

A mesma operação sem o /v1.0. A resposta traz category_id e parent_id como decimais em string. O {id} do caminho aceita UUID ou slug; não aceita o category_id decimal que a própria resposta devolve (o servidor responde 500).

Exemplo de requisição

bash

curl -u "$EMAIL:$API_KEY" \
  "$BASE_URL/api/v1.0/categories/escritorio"

Resposta

200Categoria retornada

json

{
  "category_id": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
  "category": "Escritório",
  "parent_id": "0",
  "id_path": "345ac33e-4dcd-4d60-bedf-a2c2d47897d9",
  "status": "A",
  "position": 0,
  "product_count": 2,
  "company_id": "0",
  "description": "",
  "seo_name": "escritorio",
  "page_title": "",
  "meta_description": "",
  "meta_keywords": "",
  "timestamp": 1788959480,
  "updated_timestamp": 1788959480
}

Os campos são os mesmos de Listar categorias. Quando a categoria tem imagem, a resposta traz também main_pair com o endereço dela.

Erros

Status	Quando	Corpo
401	Sem credenciais ou token expirado	`{"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.","status":401}`
404	Categoria não existe	`{"message":"Category not found","status":404}`
500	Id que não é UUID nem slug existente (inclui o id decimal da rota `/api/`)	`{"message":"query category nao-existe: pq: invalid input syntax for type uuid: \"nao-existe\" (22P02)","status":500}`

Veja também