Skip to main content

Product Categories

Manage categories for organizing rental products.

What Are Product Categories?โ€‹

Product categories help you organize your rental inventory into logical groups. Categories support a hierarchical structure with parent-child relationships, allowing you to create subcategories.

Category Structureโ€‹

Product Category
โ”œโ”€โ”€ id # Unique identifier
โ”œโ”€โ”€ name # Category name (e.g., "Bikes", "Mountain Bikes")
โ”œโ”€โ”€ description # Optional description
โ”œโ”€โ”€ image # Category image URL
โ”œโ”€โ”€ parent_id # Parent category ID (for subcategories)
โ”œโ”€โ”€ parent # Parent category summary (when loaded)
โ”œโ”€โ”€ children # Child categories (when loaded)
โ”œโ”€โ”€ product_count # Number of products in category (incl. secondary-category members)
โ””โ”€โ”€ linked_types # Other booking types this category is linked to

API Endpointsโ€‹

MethodEndpointDescriptionScope Required
GET/v1/product-categoriesList all categoriesproducts:read
GET/v1/product-categories/{id}Get a single categoryproducts:read
POST/v1/product-categoriesCreate a categoryproducts:write
PATCH/v1/product-categories/{id}Update a categoryproducts:write
DELETE/v1/product-categories/{id}Delete a categoryproducts:write

Common Use Casesโ€‹

Creating a Category Hierarchyโ€‹

Create parent and child categories:

# Create parent category
curl -X POST "https://app.equipdash.com/api/v1/product-categories" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Bikes"}'

# Create subcategory
curl -X POST "https://app.equipdash.com/api/v1/product-categories" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Mountain Bikes", "parent_id": 1}'

Building a Category Menuโ€‹

Fetch all categories for a navigation menu:

curl "https://app.equipdash.com/api/v1/product-categories" \
-H "Authorization: Bearer YOUR_API_KEY"

Filtering by Parentโ€‹

Get only top-level categories (no parent):

curl "https://app.equipdash.com/api/v1/product-categories?parent_id=null" \
-H "Authorization: Bearer YOUR_API_KEY"