Search the catalog

GET

/catalog/search

Production and sandbox. The token decides the environment.https://api.beautyrouter.com/v1/catalog/search

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://api.beautyrouter.com/v1/catalog/search',
  params: {q: 'bond repair shampoo', limit: '50'},
  headers: {Authorization: 'Bearer <token>'}
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build()

val response = client.newCall(request).execute()

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

import requests

url = "https://api.beautyrouter.com/v1/catalog/search"

querystring = {"q":"bond repair shampoo","limit":"50"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())

require 'uri'
require 'net/http'

url = URI("https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

curl --request GET \
  --url 'https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50' \
  --header 'Authorization: Bearer <token>'

import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beautyrouter.com/v1/catalog/search?q=bond%20repair%20shampoo&limit=50")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Returns the catalog products that match q. Use it to search the catalog in your own screens, with no index of your own. Each item has the same fields as a line in the catalog files, so it has the MSRP and no wholesale prices.

Authorizations

appToken

Parameters

Query Parameters

required

string

>= 1 characters

The search text.

Example

bond repair shampoo

limit

integer

default: 50 >= 1 <= 200

How many items to return.

startingAfter

string

The ID of the last item on the previous page. Leave it out for the first page.

Responses

200

A page of catalog products.

application/json

object

data

required

Array<object>

One line of a catalog file, or one search result. Products in different sizes are separate products that share a groupId. A removed product in the delta file has removed: true.

object

required

string

groupId

required

The product group, or null. Sizes of the same product share it.

string | null

brand

required

One of:

object
null

object

required

string

name

required

string

logo

required

The URL of the brand’s logo, or null.

string | null format: uri

name

required

Brand, what the product is, and size.

string

nameInGroup

required

The name that tells products in the same group apart, such as the size.

string

category

required

object

required

string

path

required

The category names from the top category down.

Array<string>

type

required

professional for use in the salon, retail for resale to clients.

string

Allowed values: professional retail

barcodes

required

Array<string>

image

required

The URL of the product image, or null.

string | null format: uri

image48x48

required

The URL of a 48x48 thumbnail, or null.

string | null format: uri

image64x64

required

The URL of a 64x64 thumbnail, or null.

string | null format: uri

description

required

string

setMembers

required

The products in a set. It is empty for a product that is not a set.

Array<object>

object

productId

required

string

quantity

required

How many of this product the set holds.

integer

>= 1

order

required

The position of the member in the set.

integer

brandId

required

The member’s own brand.

string

msrp

required

The manufacturer’s suggested retail price in US dollars, or null.

number | null

currency

required

Always usd.

string

Allowed value: usd

availableInMarketplace

required

Whether the marketplace sells the product, even if it is out of stock now. The catalog has more products than the marketplace sells.

boolean

updatedAt

required

string format: date-time

removed

Only in the delta file, on a removed product.

boolean

hasMore

required

true when another page follows.

boolean

Examples

Two sizes of a shampoo

{
  "data": [
    {
      "id": "prod-4Fz9QbX2kL",
      "groupId": "group-6Tn1vBz8Mc",
      "brand": {
        "id": "brand-5Lm2xNc7Qp",
        "name": "Amberlin",
        "logo": "https://images.beautyrouter.com/brand-5Lm2xNc7Qp/logo.png"
      },
      "name": "Amberlin Bond Repair Shampoo 33.8 fl oz",
      "nameInGroup": "33.8 fl oz",
      "category": {
        "id": "cat-0Kj5hGf4Ds",
        "path": [
          "Hair care",
          "Shampoo"
        ]
      },
      "type": "professional",
      "barcodes": [
        "850012345678"
      ],
      "image": "https://images.beautyrouter.com/prod-4Fz9QbX2kL/1.jpg",
      "image48x48": "https://images.beautyrouter.com/prod-4Fz9QbX2kL/1-48x48.jpg",
      "image64x64": "https://images.beautyrouter.com/prod-4Fz9QbX2kL/1-64x64.jpg",
      "description": "A sulfate-free shampoo that cleanses gently and strengthens chemically treated hair.",
      "setMembers": [],
      "msrp": 48,
      "currency": "usd",
      "availableInMarketplace": true,
      "updatedAt": "2026-10-28T06:12:44Z"
    },
    {
      "id": "prod-9Cv5bNm3Ws",
      "groupId": "group-6Tn1vBz8Mc",
      "brand": {
        "id": "brand-5Lm2xNc7Qp",
        "name": "Amberlin",
        "logo": "https://images.beautyrouter.com/brand-5Lm2xNc7Qp/logo.png"
      },
      "name": "Amberlin Bond Repair Shampoo 10.1 fl oz",
      "nameInGroup": "10.1 fl oz",
      "category": {
        "id": "cat-0Kj5hGf4Ds",
        "path": [
          "Hair care",
          "Shampoo"
        ]
      },
      "type": "retail",
      "barcodes": [
        "850012345685"
      ],
      "image": "https://images.beautyrouter.com/prod-9Cv5bNm3Ws/1.jpg",
      "image48x48": "https://images.beautyrouter.com/prod-9Cv5bNm3Ws/1-48x48.jpg",
      "image64x64": "https://images.beautyrouter.com/prod-9Cv5bNm3Ws/1-64x64.jpg",
      "description": "A sulfate-free shampoo that cleanses gently and strengthens chemically treated hair.",
      "setMembers": [],
      "msrp": 22,
      "currency": "usd",
      "availableInMarketplace": true,
      "updatedAt": "2026-10-28T06:12:44Z"
    }
  ],
  "hasMore": false
}

400

validation_failed: a field is missing or has a wrong value. field names it.

application/json

The body of every error response.

object

error

required

object

code

required

A stable error code.

string

Allowed values: invalid_app_token invalid_user_token user_token_expired origin_not_allowed ip_not_allowed user_cannot_manage_company user_cannot_order company_blocked company_not_verified app_setup_incomplete not_found validation_failed email_invalid_format email_domain_not_found email_mailbox_not_found address_state_without_license hazmat_destination ship_to_restricted verification_data_missing document_locked document_already_uploaded file_too_large file_type_not_supported reply_not_expected order_action_not_allowed supplier_refused_cancel order_total_changed order_has_problems idempotency_key_reused idempotency_key_in_use rate_limit_exceeded internal_error

message

required

A sentence for developers. It can change, so do not match on it.

string

field

The request field that caused the error. Only some errors have it.

string

missing

Only on verification_data_missing and app_setup_incomplete. What still needs to be set.

Array<string>

quote

Only on order_total_changed and order_has_problems. A fresh quote.

object

groups

required

One group per supplier. Each group becomes one order.

Array<object>

object

supplierId

required

string

lines

required

Array<object>

object

productId

required

string

quantity

required

integer

unitPrice

required

An amount in dollars, with up to two decimal places.

number

discount

required

The discount on the whole line, in US dollars.

number

total

required

An amount in dollars, with up to two decimal places.

number

productsTotal

required

The total of the lines, in US dollars.

number

orderDiscount

required

The discount on the whole order, in US dollars.

number

shipping

required

object

amount

required

The shipping charge in US dollars, or null when it cannot be worked out.

number | null

kind

required

string

Allowed values: free flat carrier

freeShippingRemaining

required

How much more to order for free shipping, or null when it does not apply.

number | null

salesTax

required

The sales tax in US dollars, or null when it cannot be worked out.

number | null

taxExemption

required

object

certificateId

required

The exemption certificate used, or null.

string | null

notAppliedReason

required

Why no certificate applies, or null when one does.

string | null

Allowed values: no_certificate other_state not_reviewed

total

required

The amount the salon pays for this group in US dollars, or null when it cannot be worked out. Send it back as expectedTotal. A group with problems has no expectedTotal.

number | null

chargeTiming

required

now: Beauty Router charges the card when the order is created. after_verification: the company is prequalified, so the charge waits until its verification ends.

string

Allowed values: now after_verification

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

Allowed values: buying_suspended supplier_unavailable address_state_without_license ship_to_restricted hazmat_destination address_not_deliverable connection_required connection_blocked insufficient_stock product_unavailable shipping_unavailable tax_unavailable delivery_address_required delivery_phone_required payment_card_required payment_card_unusable quantity_limit_exceeded order_limit_exceeded order_below_minimum

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

unresolvedLines

required

The lines no supplier can take.

Array<object>

object

productId

required

string

quantity

required

integer

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

companyProblems

required

What stops every group.

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

total

required

The sum of all the groups in US dollars, or null when a group’s total is.

number | null

currency

required

Always usd.

string

Allowed value: usd

Examples

validation_failed

{
  "error": {
    "code": "validation_failed",
    "message": "ein must have 9 digits.",
    "field": "ein"
  }
}

401

invalid_app_token: the Authorization header has no valid app token, or the token expired or was revoked.

application/json

The body of every error response.

object

error

required

object

code

required

A stable error code.

string

message

required

A sentence for developers. It can change, so do not match on it.

string

field

The request field that caused the error. Only some errors have it.

string

missing

Only on verification_data_missing and app_setup_incomplete. What still needs to be set.

Array<string>

quote

Only on order_total_changed and order_has_problems. A fresh quote.

object

groups

required

One group per supplier. Each group becomes one order.

Array<object>

object

supplierId

required

string

lines

required

Array<object>

object

productId

required

string

quantity

required

integer

unitPrice

required

An amount in dollars, with up to two decimal places.

number

discount

required

The discount on the whole line, in US dollars.

number

total

required

An amount in dollars, with up to two decimal places.

number

productsTotal

required

The total of the lines, in US dollars.

number

orderDiscount

required

The discount on the whole order, in US dollars.

number

shipping

required

object

amount

required

The shipping charge in US dollars, or null when it cannot be worked out.

number | null

kind

required

string

Allowed values: free flat carrier

freeShippingRemaining

required

How much more to order for free shipping, or null when it does not apply.

number | null

salesTax

required

The sales tax in US dollars, or null when it cannot be worked out.

number | null

taxExemption

required

object

certificateId

required

The exemption certificate used, or null.

string | null

notAppliedReason

required

Why no certificate applies, or null when one does.

string | null

Allowed values: no_certificate other_state not_reviewed

total

required

The amount the salon pays for this group in US dollars, or null when it cannot be worked out. Send it back as expectedTotal. A group with problems has no expectedTotal.

number | null

chargeTiming

required

now: Beauty Router charges the card when the order is created. after_verification: the company is prequalified, so the charge waits until its verification ends.

string

Allowed values: now after_verification

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

unresolvedLines

required

The lines no supplier can take.

Array<object>

object

productId

required

string

quantity

required

integer

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

companyProblems

required

What stops every group.

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

total

required

The sum of all the groups in US dollars, or null when a group’s total is.

number | null

currency

required

Always usd.

string

Allowed value: usd

Examples

invalid_app_token

{
  "error": {
    "code": "invalid_app_token",
    "message": "The app token is missing or not valid."
  }
}

403

ip_not_allowed: the app token was sent from an IP address that is not in your allowed list.

application/json

The body of every error response.

object

error

required

object

code

required

A stable error code.

string

message

required

A sentence for developers. It can change, so do not match on it.

string

field

The request field that caused the error. Only some errors have it.

string

missing

Only on verification_data_missing and app_setup_incomplete. What still needs to be set.

Array<string>

quote

Only on order_total_changed and order_has_problems. A fresh quote.

object

groups

required

One group per supplier. Each group becomes one order.

Array<object>

object

supplierId

required

string

lines

required

Array<object>

object

productId

required

string

quantity

required

integer

unitPrice

required

An amount in dollars, with up to two decimal places.

number

discount

required

The discount on the whole line, in US dollars.

number

total

required

An amount in dollars, with up to two decimal places.

number

productsTotal

required

The total of the lines, in US dollars.

number

orderDiscount

required

The discount on the whole order, in US dollars.

number

shipping

required

object

amount

required

The shipping charge in US dollars, or null when it cannot be worked out.

number | null

kind

required

string

Allowed values: free flat carrier

freeShippingRemaining

required

How much more to order for free shipping, or null when it does not apply.

number | null

salesTax

required

The sales tax in US dollars, or null when it cannot be worked out.

number | null

taxExemption

required

object

certificateId

required

The exemption certificate used, or null.

string | null

notAppliedReason

required

Why no certificate applies, or null when one does.

string | null

Allowed values: no_certificate other_state not_reviewed

total

required

The amount the salon pays for this group in US dollars, or null when it cannot be worked out. Send it back as expectedTotal. A group with problems has no expectedTotal.

number | null

chargeTiming

required

now: Beauty Router charges the card when the order is created. after_verification: the company is prequalified, so the charge waits until its verification ends.

string

Allowed values: now after_verification

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

unresolvedLines

required

The lines no supplier can take.

Array<object>

object

productId

required

string

quantity

required

integer

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

companyProblems

required

What stops every group.

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

total

required

The sum of all the groups in US dollars, or null when a group’s total is.

number | null

currency

required

Always usd.

string

Allowed value: usd

Examples

ip_not_allowed

{
  "error": {
    "code": "ip_not_allowed",
    "message": "This IP address is not in the allowed list of your salon app."
  }
}

500

internal_error: something failed on Beauty Router’s side. Try again later.

application/json

The body of every error response.

object

error

required

object

code

required

A stable error code.

string

message

required

A sentence for developers. It can change, so do not match on it.

string

field

The request field that caused the error. Only some errors have it.

string

missing

Only on verification_data_missing and app_setup_incomplete. What still needs to be set.

Array<string>

quote

Only on order_total_changed and order_has_problems. A fresh quote.

object

groups

required

One group per supplier. Each group becomes one order.

Array<object>

object

supplierId

required

string

lines

required

Array<object>

object

productId

required

string

quantity

required

integer

unitPrice

required

An amount in dollars, with up to two decimal places.

number

discount

required

The discount on the whole line, in US dollars.

number

total

required

An amount in dollars, with up to two decimal places.

number

productsTotal

required

The total of the lines, in US dollars.

number

orderDiscount

required

The discount on the whole order, in US dollars.

number

shipping

required

object

amount

required

The shipping charge in US dollars, or null when it cannot be worked out.

number | null

kind

required

string

Allowed values: free flat carrier

freeShippingRemaining

required

How much more to order for free shipping, or null when it does not apply.

number | null

salesTax

required

The sales tax in US dollars, or null when it cannot be worked out.

number | null

taxExemption

required

object

certificateId

required

The exemption certificate used, or null.

string | null

notAppliedReason

required

Why no certificate applies, or null when one does.

string | null

Allowed values: no_certificate other_state not_reviewed

total

required

The amount the salon pays for this group in US dollars, or null when it cannot be worked out. Send it back as expectedTotal. A group with problems has no expectedTotal.

number | null

chargeTiming

required

now: Beauty Router charges the card when the order is created. after_verification: the company is prequalified, so the charge waits until its verification ends.

string

Allowed values: now after_verification

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

unresolvedLines

required

The lines no supplier can take.

Array<object>

object

productId

required

string

quantity

required

integer

problems

required

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

companyProblems

required

What stops every group.

Array<object>

object

code

required

What stops a group or the whole request. See Problems.

string

message

required

A sentence you can show. It can change, so do not match on it.

string

productId

The product. Only on problems with one product.

string

supplierId

The supplier. Only on problems with one supplier.

string

available

How many units can be ordered. Only on insufficient_stock.

integer

total

required

The sum of all the groups in US dollars, or null when a group’s total is.

number | null

currency

required

Always usd.

string

Allowed value: usd

Examples

internal_error

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong. Try again later."
  }
}