Features
You connect your salon app to Beauty Router once, then choose how to use each feature. Some features come only as Beauty Router’s embedded interface, some only through the API, and some both ways. You can mix them, and move a feature from one to the other later.
Every integration needs the login call on your server and a webhook endpoint for order updates.
| Feature | Embedded interface | API |
|---|---|---|
| Login and logout | Not available | POST /v1/login, from your server, and POST /v1/logout |
| Catalog | Not available | Catalog files and search |
| Product matching | Not available | /v1/product-matches |
| Company verification | showVerification |
Company, license, and certificate endpoints |
| Payment cards | showVerification, showPaymentCards |
GET /v1/company/payment-cards, read only |
| Service selection | showServiceSelector |
GET /v1/services, /v1/company/services, and /v1/user/services |
| Marketplace: browse, favorites, cart | showMarketplace, showFavorites, showCart |
Not available |
| Order creation | showCart, showCheckout |
POST /v1/products/offers, /v1/orders/quote, /v1/orders/batch |
| Drafts | showCheckout, showOrders |
saveAsDraft on batch, GET /v1/orders?status=draft, DELETE /v1/orders/{orderId} |
| Product details | showProductDetails |
GET /v1/catalog/products/{productId} |
| Supplier list | Not available | GET /v1/company/suppliers, archive and restore |
| Supplier profile | showSupplier |
GET /v1/company/suppliers with supplierIds |
| Delivery estimates | Not available | GET /v1/company/delivery-estimates |
| Order list | showOrders |
GET /v1/orders |
| Order details | showOrder |
GET /v1/orders/{orderId} |
| Order changes | showOrder |
Cancel, and change the delivery address |
| Order tracking | showOrderTracking |
trackingNumbers on the order |
| Order rating | showOrderRating, showOrder |
Not available |
| Order updates | onOrderCreated callback |
Webhooks |
Beauty Router sends the emails for you. You set your app’s details in the salon app admin area and build the pages their links open.
Embedded interface
Section titled “Embedded interface”You place Beauty Router’s interface in your salon app with the JavaScript library, and you choose where each part opens. Beauty Router runs the catalog, payments, sales tax, and order routing behind it. This is the fastest way to start.
Customize the interface
Section titled “Customize the interface”The embedded interface can follow your own design:
- You share your design guide with the Beauty Router team, with any other materials that help.
- The team creates a new design, specifically for your salon app.
- You select that design in the salon app admin area.
Once you select it, the design applies automatically to all embedded interface sessions, so your code does not change. Each environment has its own selection, so you can check the design in the sandbox first.
You build your own screens and server code for the features the API covers. A step with no API, such as browsing the marketplace or entering a payment card, still uses the embedded interface.
