Skip to content
Beauty RouterBeauty Router Docs

Overview

View as Markdown

Beauty Router API 1.1.17

Section titled “Beauty Router API 1.1.17”

The Beauty Router API connects your salon app to the Beauty Router marketplace. It logs in your users, links the catalog files, searches the catalog, returns product details, matches the products your users typed in, collects company details for verification, saves the services a company offers, lists suppliers, and creates, lists, and changes orders.

Every request sends a token as Authorization: Bearer <token>. POST /v1/login, GET /v1/catalog/files, and GET /v1/catalog/search send your app token, from your server only. Every other endpoint sends the user token, and your frontend can make those requests. See Authentication and Conventions.

For endpoints the API does not have, write to dev@beautyrouter.com.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/login
POST
/logout
GET
/catalog/files
GET
/catalog/search
GET
/catalog/products/{productId}
GET
/product-matches
POST
/product-matches
GET
/product-matches/{matchId}
PUT
/product-matches/{matchId}
GET
/company
PUT
/company
GET
/company/licenses
POST
/company/licenses
DELETE
/company/licenses/{licenseId}
GET
/company/exemption-certificates
POST
/company/exemption-certificates
DELETE
/company/exemption-certificates/{certificateId}
POST
/company/verification
GET
/company/payment-cards
GET
/services
GET
/company/services
PUT
/company/services
GET
/user/services
PUT
/user/services
DELETE
/user/services
GET
/company/suppliers
POST
/company/suppliers/{supplierId}/archive
POST
/company/suppliers/{supplierId}/restore
GET
/company/delivery-estimates
POST
/products/offers
POST
/orders/quote
POST
/orders/batch
GET
/orders
GET
/orders/{orderId}
DELETE
/orders/{orderId}
POST
/orders/{orderId}/cancel
PUT
/orders/{orderId}/delivery-address
POST
order.created WEBHOOK
POST
order.updated WEBHOOK
POST
company.verification_updated WEBHOOK
POST
product_match.updated WEBHOOK

Authentication

Section titled “Authentication”

appToken

Section titled “appToken”

Your salon app’s token, from the salon app admin area, such as br-apptoken-live-<token> or br-apptoken-sandbox-<token>. Keep it on your server. Never put it in browser or mobile code.

Security scheme type: http

Bearer format: br-apptoken-live-<token>

userToken

Section titled “userToken”

The user token from POST /v1/login, such as br-usertoken-live-<token> or br-usertoken-sandbox-<token>. It lasts 24 hours and can go to your frontend. A browser request must come from an origin you added in the salon app admin area. origin_not_allowed means the origin is not registered in your salon app admin area. A browser may report this as a CORS error instead.

Security scheme type: http

Bearer format: br-usertoken-live-<token>