Categories API
Categories help you organize your products and experiences into logical groups for easier navigation and management.
What is a Category?
A category is a grouping mechanism that helps:
- Organize your catalog: Group similar items together
- Improve navigation: Help customers find what they're looking for
- Filter listings: Search within specific categories
- Structure your business: Separate product lines or service types
Two Types of Categories
EquipDash has separate category systems for products and experiences:
Product Categories
Organize rental items:
| Category | Example Products |
|---|---|
| Bikes | Mountain bikes, road bikes, e-bikes |
| Water Sports | Kayaks, paddleboards, wetsuits |
| Camping | Tents, sleeping bags, backpacks |
| Winter Sports | Skis, snowboards, boots |
Experience Categories
Organize tours and activities:
| Category | Example Experiences |
|---|---|
| Water Activities | Kayak tours, snorkeling, diving |
| Adventure | Hiking tours, climbing, zip-lining |
| Classes & Lessons | Surf lessons, yoga, cooking classes |
| Cultural | City tours, museum tours, food tours |
Category Structure
Categories support hierarchical organization with parent-child relationships:
Category
├── id
├── name
├── description (optional)
├── image (optional)
├── parent_id (for subcategories)
├── parent (parent category summary)
├── children (child categories)
└── items_count (products or experiences)
API Endpoints
Product Categories
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/product-categories | List all product categories | products:read |
GET | /v1/product-categories/{id} | Get a single category | products:read |
POST | /v1/product-categories | Create a category | products:write |
PATCH | /v1/product-categories/{id} | Update a category | products:write |
DELETE | /v1/product-categories/{id} | Delete a category | products:write |
Experience Categories
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/experience-categories | List all experience categories | experiences:read |
GET | /v1/experience-categories/{id} | Get a single category | experiences:read |
POST | /v1/experience-categories | Create a category | experiences:write |
PATCH | /v1/experience-categories/{id} | Update a category | experiences:write |
DELETE | /v1/experience-categories/{id} | Delete a category | experiences:write |
Common Use Cases
Building a Catalog Navigation
Fetch categories to build your website navigation:
# Get product categories
curl "https://app.equipdash.com/api/v1/product-categories" \
-H "Authorization: Bearer YOUR_API_KEY"
# Get experience categories
curl "https://app.equipdash.com/api/v1/experience-categories" \
-H "Authorization: Bearer YOUR_API_KEY"
Filtering Products by Category
List products in a specific category:
curl "https://app.equipdash.com/api/v1/products?category_id=5" \
-H "Authorization: Bearer YOUR_API_KEY"
Creating a Category Hierarchy
# 1. 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"}'
# 2. 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}'
Related Resources
- Products - Products belong to categories
- Experiences - Experiences belong to categories