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

Endpoints de categorias

As URLs da API de categorias e os métodos aceitos por cada uma: coleção, categoria específica e os produtos de uma categoria.

A API de categorias permite gerenciar as categorias de produtos. Esta página descreve os endpoints disponíveis e os métodos HTTP aceitos em cada um. Todos usam credenciais HTTP Basic ($EMAIL:$API_KEY) e o endereço base da sua loja ($BASE_URL).

A coleção de categorias

O caminho /api/categories permite listar todas as categorias ou criar uma nova categoria.

MétodoDescriçãoUso
GETListar todas as categoriasUse os parâmetros de paginação para limitar os resultados. Veja Paginação.
POSTCriar uma nova categoriaExige um corpo JSON com os dados da categoria.

Listar categorias

GET/api/categoriesAdmin

Listar todas as categorias

Parâmetros de consulta

pageinteger
Página da lista, veja Paginação.
items_per_pageinteger
Quantidade de categorias por página.
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/categories?page=1&items_per_page=10"
200Resposta da listagem
json
{
  "categories": [
    {
      "category_id": 16,
      "category": "Electronics",
      "description": "All electronic devices and accessories",
      "parent_id": 0,
      "status": "A",
      "position": 10,
      "product_count": 156
    },
    {
      "category_id": 18,
      "category": "Home & Kitchen",
      "description": "Products for your home and kitchen",
      "parent_id": 0,
      "status": "A",
      "position": 20,
      "product_count": 203
    }
  ],
  "params": {
    "page": 1,
    "items_per_page": 10,
    "total_items": 42
  }
}

Criar uma categoria

POST/api/categoriesAdmin

Criar uma nova categoria

Corpo da requisição

categorystring
O nome da categoria.
descriptionstring
A descrição da categoria.
parent_idinteger
O ID da categoria pai. 0 é uma categoria de nível superior.
statusstring
AHD
O status da categoria, veja a tabela de status no fim desta página.
meta_titlestring
Título da página para os mecanismos de busca.
meta_descriptionstring
Meta description para os mecanismos de busca.
positioninteger
Posição na ordem de exibição.
bash
curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/categories" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "Electronics",
  "description": "All electronic devices and accessories",
  "parent_id": 0,
  "status": "A",
  "meta_title": "Electronics - Best Deals",
  "meta_description": "Shop the latest in electronics and tech gadgets",
  "position": 10
}'

Uma categoria específica

O caminho /api/categories/{id} permite trabalhar com uma categoria específica, identificada pelo ID. O parâmetro de caminho id (integer) é o identificador único da categoria.

MétodoDescriçãoUso
GETObter uma categoria específicaRetorna informações detalhadas da categoria indicada.
PUTAtualizar uma categoriaExige um corpo JSON com os campos a atualizar.
DELETEExcluir uma categoriaRemove a categoria do sistema de forma permanente.

Obter uma categoria

GET/api/categories/{id}Admin

Obter uma categoria específica

Parâmetros de caminho

idintegerobrigatório
O identificador único da categoria.

Atualizar uma categoria

PUT/api/categories/{id}Admin

Atualizar uma categoria

Exige um corpo JSON com os campos a atualizar. A referência apidoc não lista os campos aceitos neste método: o exemplo usa propriedades da categoria da tabela em Categorias (REST).

Parâmetros de caminho

idintegerobrigatório
O identificador único da categoria.

Corpo da requisição

categorystring
O nome da categoria.
descriptionstring
A descrição da categoria.
positioninteger
Posição na ordem de exibição.
bash
curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/categories/16" \
  -H "Content-Type: application/json" \
  -d '{
  "category": "Electronics",
  "description": "All electronic devices and accessories",
  "position": 10
}'

A referência não mostra o corpo da resposta nem a lista de status de erro deste método.

Excluir uma categoria

DELETE/api/categories/{id}Admin

Excluir uma categoria

Parâmetros de caminho

idintegerobrigatório
O identificador único da categoria.
Atenção

Ao excluir uma categoria, todos os produtos atribuídos a ela precisam ser reatribuídos a outra categoria, ou ficarão órfãos. Considere atualizar os produtos antes de excluir uma categoria.

Produtos de uma categoria

Listar os produtos de uma categoria

GET/api/categories/{id}/productsAdmin

Listar todos os produtos atribuídos a uma categoria

Parâmetros de caminho

idintegerobrigatório
O identificador único da categoria.
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/categories/16/products?status=A&page=2&items_per_page=20"
Dica

Você pode usar parâmetros de paginação e de filtro para restringir os resultados. Por exemplo, ?status=A&page=2&items_per_page=20 retorna os produtos ativos da página 2, com 20 itens por página.

Obter um produto de uma categoria

GET/api/categories/{category_id}/products/{product_id}Admin

Obter os detalhes de um produto específico dentro de uma categoria específica

Parâmetros de caminho

category_idintegerobrigatório
O identificador único da categoria.
product_idintegerobrigatório
O identificador único do produto.
Nota

Este endpoint retorna erro 404 se o produto existir, mas não estiver atribuído à categoria indicada.

Códigos de status da categoria

Código de statusDescrição
AAtiva: a categoria está visível e ativa.
HOculta: a categoria existe, mas não está visível para os clientes.
DDesativada: a categoria está temporariamente desativada.

Veja também

  • Categorias (REST)
  • Paginação
  • Objetos aninhados
Anterior
Categorias (REST)
Próxima
Objetos aninhados
Nesta página
  • A coleção de categorias
  • Listar categorias
  • Criar uma categoria
  • Uma categoria específica
  • Obter uma categoria
  • Atualizar uma categoria
  • Excluir uma categoria
  • Produtos de uma categoria
  • Listar os produtos de uma categoria
  • Obter um produto de uma categoria
  • Códigos de status da categoria
  • Veja também