Categorias (REST)
Categorias hierárquicas de produtos: propriedades, letras de status e os endpoints de listar, consultar e criar da REST API genérica.
As categorias dão uma estrutura hierárquica para organizar os produtos da sua loja. A API de categorias permite gerenciar a estrutura de categorias, adicionar ou remover produtos de categorias e personalizar configurações específicas de cada categoria.
As categorias da Venddor podem ser organizadas em uma hierarquia de vários níveis, o que dá uma navegação flexível e intuitiva para os seus clientes. Cada categoria pode ter qualquer número de subcategorias, e um produto pode pertencer a várias categorias ao mesmo tempo. As rotas desta seção ficam em $BASE_URL/api/categories e usam credenciais HTTP Basic ($EMAIL:$API_KEY).
Propriedades da categoria
Propriedades da categoria
category_idintegercategorystringparent_idintegerstatusstringAHDproduct_countintegerpositionintegerdescriptionstringmeta_keywordsstringmeta_descriptionstringpage_titlestringimage_pairobjectEndpoints
| Método | Caminho | Finalidade | Autenticação |
|---|---|---|---|
| GET | /api/categories | Listar as categorias, com filtros opcionais (descrito abaixo) | Administrador |
| GET | /api/categories/{category_id} | Obter uma categoria específica (descrito abaixo) | Administrador |
| POST | /api/categories | Criar uma categoria (descrito abaixo) | Administrador |
| PUT | /api/categories/{id} | Atualizar uma categoria, veja Endpoints | Administrador |
| DELETE | /api/categories/{id} | Excluir uma categoria, veja Endpoints | Administrador |
| GET | /api/categories/{id}/products | Listar os produtos de uma categoria, veja Endpoints | Administrador |
| GET | /api/categories/{id}/products/{id} | Obter um produto dentro de uma categoria, veja Endpoints | Administrador |
Listar categorias
/api/categoriesAdminListar todas as categorias, com filtros opcionais
Parâmetros de consulta
parent_idintegerstatusstringAHDinclude_disabledbooleanpadrão: falsepageintegerpadrão: 1items_per_pageintegerpadrão: 20curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/categories?parent_id=1&status=A"{
"categories": [
{
"category_id": "1",
"category": "Electronics",
"parent_id": "0",
"status": "A",
"product_count": 125,
"position": 10,
"description": "<p>Shop our wide selection of electronics</p>",
"meta_keywords": "electronics, gadgets, tech",
"meta_description": "Browse our selection of electronics and tech gadgets.",
"page_title": "Electronics and Tech Gadgets"
},
{
"category_id": "2",
"category": "Smartphones",
"parent_id": "1",
"status": "A",
"product_count": 42,
"position": 20,
"description": "<p>Latest smartphones and accessories</p>",
"meta_keywords": "smartphones, phones, mobile",
"meta_description": "Shop the latest smartphones and mobile accessories.",
"page_title": "Smartphones & Mobile Devices"
}
],
"pagination": {
"total": 42,
"current_page": 1,
"items_per_page": 20,
"total_pages": 3
}
}Obter uma categoria
/api/categories/{category_id}AdminObter os detalhes de uma categoria específica
Parâmetros de caminho
category_idintegerobrigatórioCriar uma categoria
/api/categoriesAdminCriar uma nova categoria
Corpo da requisição
categorystringobrigatórioparent_idintegerpadrão: 0statusstringpadrão: AAHDdescriptionstringpositionintegerpadrão: 0O exemplo original também envia meta_keywords, meta_description e page_title, que são propriedades da categoria (veja a tabela acima).
curl -X POST -u "$EMAIL:$API_KEY" "$BASE_URL/api/categories" \
-H "Content-Type: application/json" \
-d '{
"category": "Smart Home Devices",
"parent_id": "1",
"status": "A",
"description": "<p>Discover the latest smart home technology</p>",
"position": 30,
"meta_keywords": "smart home, automation, IoT",
"meta_description": "Shop smart home devices and automation products.",
"page_title": "Smart Home & Automation"
}'{
"success": true,
"category_id": "3"
}