Api reference
Catalogue
The catalogue surface covers everything visible to a shopper: products and variants, categories, collections, bundles, composites, and the modifier groups (add-ons) attached to them. All endpoints live under `/api/v1/catalogue` and accept an optional `location_id` query parameter for location-specific pricing and availability.
Quick reference
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/catalogue | Combined catalogue snapshot |
| GET | /api/v1/catalogue/products | List products with filters |
| GET | /api/v1/catalogue/products/{id} | Get a product |
| GET | /api/v1/catalogue/products/{id}/variants | List variants |
| POST | /api/v1/catalogue/products/{id}/variants/find | Find variant by axes |
| GET | /api/v1/catalogue/products/{id}/add-ons | Modifier groups for a product |
| GET | /api/v1/catalogue/categories | List categories |
| GET | /api/v1/catalogue/collections | List collections |
| GET | /api/v1/catalogue/bundles | List bundles |
| GET | /api/v1/catalogue/composites | List composites |
| POST | /api/v1/catalogue/composites/{id}/calculate-price | Price a build-your-own selection |
| POST | /api/v1/catalogue/quotes | Create a price quote |
| POST | /api/v1/catalogue/deals/validate | Validate a discount code |
Product types
| Type | Description |
|---|---|
product | Physical or digital good. |
service | Time-bookable; pairs with the scheduling endpoints. |
bundle | Fixed combination of components. |
composite | Build-your-own with component groups. |
Sections
- Products: List, retrieve, look up by slug, fetch deals, billing plans, schedules
- Variants: Variant axes, find-by-axes, get-by-id
- Categories: Category trees, products in a category, attributes, deals
- Collections: Curated groupings with their products and attributes
- Bundles: Fixed-component bundles
- Composites: Build-your-own products with calculate-price
- Add-Ons: Modifier groups attached to products