The Categories API allows you to manage product categories in the Venddor platform. This documentation outlines the available endpoints and their supported HTTP methods.
https://www.venddor.com.br/api
This endpoint allows you to retrieve all categories or create a new category.
| Method | Description | Usage |
|---|---|---|
| GET | Retrieve all categories | Use pagination parameters to limit results. See Pagination section for details. |
| POST | Create a new category | Requires a JSON body with category details. |
{
"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
}
{
"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
}
}
This endpoint allows you to work with a specific category identified by its ID.
| Parameter | Type | Description |
|---|---|---|
| id* | integer | The unique identifier of the category |
| Method | Description | Usage |
|---|---|---|
| GET | Retrieve a specific category | Returns detailed information about the specified category |
| PUT | Update a category | Requires a JSON body with fields to update |
| DELETE | Delete a category | Permanently removes the category from the system |
This endpoint allows you to retrieve all products assigned to a specific category.
| Parameter | Type | Description |
|---|---|---|
| id* | integer | The unique identifier of the category |
?status=A&page=2&items_per_page=20 will return active products on page 2 with 20 items per page.
This endpoint allows you to retrieve details about a specific product within a specific category.
| Parameter | Type | Description |
|---|---|---|
| category_id* | integer | The unique identifier of the category |
| product_id* | integer | The unique identifier of the product |
| Status Code | Description |
|---|---|
A |
Active - Category is visible and active |
H |
Hidden - Category exists but is not visible to customers |
D |
Disabled - Category is temporarily disabled |