BrightNest API
REST for the shop and the apps
Base URL /api/v1. Customers authenticate with a Sanctum bearer token. Marketing ingestion uses the X-Api-Key header. Prices are AED and include VAT.
| GET | /api/v1/home |
Banners, categories, arrivals, bestsellers |
| GET | /api/v1/products |
Filters: q, category, brand, age, price, offers, sort |
| GET | /api/v1/products/{slug} |
Product, variants, reviews, related |
| GET | /api/v1/gift-finder |
age_group, gender, budget, interest, occasion |
| POST | /api/v1/auth/register |
name, email, phone, password, password_confirmation |
| POST | /api/v1/auth/login |
email, password → token |
| GET | /api/v1/cart |
Bearer token |
| POST | /api/v1/cart/items |
product_id, variant, quantity |
| POST | /api/v1/checkout |
Address, shipping method, payment method |
| POST | /api/v1/guest/checkout |
Same payload plus items[] |
| GET | /api/v1/orders |
Order history and tracking status |
| POST | /api/v1/events |
X-Api-Key. event, properties, anonymous_id, customer_id |
| POST | /api/v1/identify |
Merge anonymous events onto a customer |
| POST | /api/v1/customers |
Create or update a customer profile |
| POST | /api/v1/orders |
Record a purchase for conversion tracking |
| POST | /api/v1/devices |
FCM/APNs token, platform ios or android |
| POST | /api/v1/web-push |
Browser push subscription |
| GET | /api/v1/in-app |
Active in-app messages and deep links |
| POST | /api/v1/partners |
Wholesale enquiry |
Demo customer token and SDK key are printed in the README after seeding.