Product Availability API
The Availability API lets you check real-time availability for products before creating bookings.
Why Check Availability?
Before adding products to a booking, verify they're available:
- Check inventory levels and existing reservations
- Prevent overbooking
- Display accurate availability on your website
API Endpoints
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/availability/products | Check product availability | products:read |
POST | /v1/availability/products/bulk | Bulk check multiple products | products:read |
Product Availability
Products can have different inventory tracking modes:
| Mode | Description | Availability Check |
|---|---|---|
none | No inventory tracking | Always available (returns 999) |
group | Track total quantity | Checks against total inventory |
item | Track individual items | Checks specific item availability |
What Affects Availability
- Existing bookings for the date range
- Items in workshop (being repaired/maintained)
- Scheduled downtime (maintenance periods)
- Buffer times between rentals
On Hand vs Bookable
Every product row reports two quantities:
| Field | Meaning |
|---|---|
available_quantity | Units physically on hand for the window. Show this when you want a person to see real stock |
bookable_quantity | Units that may actually be sold. Read this — or the available flag, which is computed from it — to decide whether a booking will be accepted |
The two match for most products. They differ only when a product is set to
keep selling when sold out: the shop has told
EquipDash it can source a few extra units at short notice, so bookable_quantity adds whatever is
left of that allowance on top of the units on hand. Bookings taken past stock are accepted and
flagged, and each rental line records how many units it sold short in shortage_quantity.
Common Use Cases
Pre-Booking Validation
Before creating a booking, check all items are available:
curl -X POST "https://app.equipdash.com/api/v1/availability/products/bulk" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{"product_id": 1, "quantity": 2},
{"product_id": 5, "variation_id": 12, "quantity": 1}
],
"start_date": "2026-02-15T09:00:00Z",
"end_date": "2026-02-17T17:00:00Z"
}'
Real-Time Inventory Display
Show available quantities on your website:
curl "https://app.equipdash.com/api/v1/availability/products?product_id=1&start_date=2026-02-15&end_date=2026-02-17" \
-H "Authorization: Bearer YOUR_API_KEY"
Check Specific Variation
Check availability for a product variation:
curl "https://app.equipdash.com/api/v1/availability/products?product_id=1&variation_id=5&quantity=2&start_date=2026-02-15&end_date=2026-02-17" \
-H "Authorization: Bearer YOUR_API_KEY"