Promotions API
The Promotions API provides read-only access to your promo codes and vouchers/gift cards.
Promo Codes vs Vouchers
EquipDash supports two types of promotional tools:
| Type | Description | Example |
|---|---|---|
| Promo Codes | Discount codes customers enter at checkout | "SUMMER25" for 25% off |
| Vouchers/Gift Cards | Prepaid value that can be redeemed | $100 gift card |
Promo Codes
Promo codes offer discounts with various rules:
Discount Types
| Type | Description | Example |
|---|---|---|
percentage | Percentage off the booking | 25% off |
flat | Flat amount off | $10 off |
Promo Code Rules
| Rule | Description |
|---|---|
min_booking_amount | Minimum booking value required |
max_discount_amount | Cap on percentage discounts |
valid_from / valid_until | Date range validity |
max_uses | Total usage limit |
max_uses_per_customer | Per-customer limit |
apply_to_all_products | Works on all products |
apply_to_all_experiences | Works on all experiences |
Vouchers / Gift Cards
Vouchers are prepaid credit that can be applied to bookings:
Voucher Status
| Status | Description |
|---|---|
active | Has remaining balance, within validity |
redeemed | Fully used (zero balance) |
expired | Past validity date |
Voucher Sources
| Source | Description |
|---|---|
online_purchase | Bought through online store |
pos | Sold at point of sale |
manual | Manually created by staff |
API Endpoints
Promo Codes
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/promo-codes | List all promo codes | promotions:read |
GET | /v1/promo-codes/{id} | Get a single promo code | promotions:read |
POST | /v1/promo-codes | Create a promo code | promotions:write |
POST | /v1/promo-codes/import | Bulk import promo codes | promotions:write |
PATCH | /v1/promo-codes/{id} | Update a promo code | promotions:write |
DELETE | /v1/promo-codes/{id} | Delete a promo code | promotions:write |
POST | /v1/promo-codes/validate | Validate a promo code | promotions:read |
Vouchers
| Method | Endpoint | Description | Scope Required |
|---|---|---|---|
GET | /v1/vouchers | List all vouchers | promotions:read |
GET | /v1/vouchers/{id} | Get a single voucher | promotions:read |
POST | /v1/vouchers | Create a voucher | promotions:write |
POST | /v1/vouchers/import | Bulk import vouchers | promotions:write |
PATCH | /v1/vouchers/{id} | Update a voucher | promotions:write |
DELETE | /v1/vouchers/{id} | Delete a voucher | promotions:write |
POST | /v1/vouchers/validate | Validate a voucher | promotions:read |
POST | /v1/vouchers/balance | Check voucher balance | promotions:read |
Common Use Cases
Checking Promo Code Status
Monitor promo code usage and validity:
curl "https://app.equipdash.com/api/v1/promo-codes?status=active" \
-H "Authorization: Bearer YOUR_API_KEY"
Tracking Gift Card Balances
Get voucher details including remaining balance:
curl "https://app.equipdash.com/api/v1/vouchers/123" \
-H "Authorization: Bearer YOUR_API_KEY"
Marketing Analytics
Track promo code performance:
# Get all promo codes with usage counts
curl "https://app.equipdash.com/api/v1/promo-codes" \
-H "Authorization: Bearer YOUR_API_KEY"
Response includes uses_count to track redemptions.