Get offers

POST

/products/offers

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.beautyrouter.com/v1/products/offers"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"productIds\": [ \"prod-4Fz9QbX2kL\" ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://api.beautyrouter.com/v1/products/offers"

  payload := strings.NewReader("{ \"productIds\": [ \"prod-4Fz9QbX2kL\" ] }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  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();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"productIds\": [ \"prod-4Fz9QbX2kL\" ] }");
Request request = new Request.Builder()
  .url("https://api.beautyrouter.com/v1/products/offers")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

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

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://api.beautyrouter.com/v1/products/offers',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  data: {productIds: ['prod-4Fz9QbX2kL']}
};

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

const url = 'https://api.beautyrouter.com/v1/products/offers';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"productIds":["prod-4Fz9QbX2kL"]}'
};

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

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"productIds\": [ \"prod-4Fz9QbX2kL\" ] }")
val request = Request.Builder()
  .url("https://api.beautyrouter.com/v1/products/offers")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

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

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.beautyrouter.com/v1/products/offers', [
  'body' => '{ "productIds": [ "prod-4Fz9QbX2kL" ] }',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

import requests

url = "https://api.beautyrouter.com/v1/products/offers"

payload = { "productIds": ["prod-4Fz9QbX2kL"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

require 'uri'
require 'net/http'

url = URI("https://api.beautyrouter.com/v1/products/offers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{ \"productIds\": [ \"prod-4Fz9QbX2kL\" ] }"

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

curl --request POST \
  --url https://api.beautyrouter.com/v1/products/offers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "productIds": [ "prod-4Fz9QbX2kL" ] }'

import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["productIds": ["prod-4Fz9QbX2kL"]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.beautyrouter.com/v1/products/offers")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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 who sells each product and at what price, for the rows of a New order page. This is the one batch endpoint in the API. Call it for the visible rows and the selected rows, in chunks of 500.

It skips suppliers that cannot ship to the address, and uses the company’s delivery address when you send none. When you name a supplierId, that supplier comes back with canShipToAddress: false instead of being skipped. A supplier that is archived_by_supplier or blocked still comes back, flagged by status, so your page can show why. It is never recommended.

Each product’s offers are sorted best first: in stock first, then suppliers the company is connected to, then by rating. Only prequalified and verified companies can call it.

Authorizations

userToken

Request Body^required

application/json

object

productIds

required

Array<string>

>= 1 items <= 500 items

supplierId

Return only the offers of this supplier.

string

deliveryAddress

The delivery address. Without it, Beauty Router uses the company’s.

object

line1

required

Street address.

string

line2

Suite, unit, or floor.

string

city

required

string

state

required

A two-letter US state code.

string

/^[A-Z]{2}$/

postalCode

required

ZIP code.

string

country

required

string

Allowed value: US

phone

Phone number for the delivery. Required on the company. Optional on an order, which then uses the company’s phone.

string

Examples

One product

{
  "productIds": [
    "prod-4Fz9QbX2kL"
  ]
}

Responses

200

The offers per product, and the suppliers they refer to.

application/json

object

products

required

Array<object>

object

productId

required

string

hazardousMaterials

required

boolean

type

required

string

Allowed values: professional retail

offers

required

The offers, best first.

Array<object>

object

supplierId

required

string

unitPrice

required

The wholesale price of one unit before discounts, in US dollars.

number

available

required

How many units can be ordered now.

integer

status

required

string

Allowed values: published unavailable discontinued

plannedAvailability

required

The date the product is back in stock, or null.

string | null format: date

discountLevels

required

Array<object>

object

minQuantity

required

The quantity from which this discount applies.

integer

discountPercent

required

The discount in percent, or 0 when discountAmount applies.

number

discountAmount

required

The discount per unit in US dollars, or 0 when discountPercent applies.

number

name

required

The name of the discount, or null.

string | null

endsAt

required

The date the discount ends, or null.

string | null format: date

recommended

required

true on the first offer.

boolean

suppliers

required

The suppliers the offers refer to.

Array<object>

object

required

string

name

required

string

logo

required

string | null format: uri

rating

required

integer | null

<= 100

status

required

active: the salon location can order from the supplier. archived_by_client: the salon archived the supplier. archived_by_supplier: the supplier archived the salon location, and the salon cannot order from it any more. blocked: Beauty Router blocked the supplier.

string

Allowed values: active archived_by_client archived_by_supplier blocked

maxQuantityPerOrder

required

The most units of one product in one order.

integer

>= 1

freeShippingThreshold

required

Orders at or above this amount ship free. null when the supplier has no free shipping.

number | null

shippingFee

required

The flat shipping charge. null when shippingType is carrier.

number | null

shippingType

required

flat for a flat amount, carrier for a carrier quote.

string

Allowed values: flat carrier

orderDiscountLevels

required

Discounts on the whole order.

Array<object>

object

minAmount

required

The order amount from which this discount applies, in US dollars.

number

discountPercent

required

The discount in percent, or 0 when discountAmount applies.

number

discountAmount

required

The discount on the order in US dollars, or 0 when discountPercent applies.

number

name

required

The name of the discount, or null.

string | null

endsAt

required

The date the discount ends, or null.

string | null format: date

canShipToAddress

required

Whether the supplier ships to the address. It can be false only for a supplier you named.

boolean

currency

required

Always usd.

string

Allowed value: usd

Examples

One product

{
  "products": [
    {
      "productId": "prod-4Fz9QbX2kL",
      "hazardousMaterials": false,
      "type": "professional",
      "offers": [
        {
          "supplierId": "sup-1Ry6tUi3Op",
          "unitPrice": 24.5,
          "available": 120,
          "status": "published",
          "plannedAvailability": null,
          "discountLevels": [
            {
              "minQuantity": 12,
              "discountPercent": 10,
              "discountAmount": 0,
              "name": "Salon Stock-Up",
              "endsAt": "2026-12-31"
            }
          ],
          "recommended": true
        }
      ]
    }
  ],
  "suppliers": [
    {
      "id": "sup-1Ry6tUi3Op",
      "name": "Amberlin",
      "logo": "https://images.beautyrouter.com/sup-1Ry6tUi3Op/logo.png",
      "rating": 94,
      "status": "active",
      "maxQuantityPerOrder": 48,
      "freeShippingThreshold": 150,
      "shippingFee": 12,
      "shippingType": "flat",
      "orderDiscountLevels": [
        {
          "minAmount": 500,
          "discountPercent": 5,
          "discountAmount": 0,
          "name": "Holiday Order Bonus",
          "endsAt": "2026-12-31"
        }
      ],
      "canShipToAddress": true
    }
  ],
  "currency": "usd"
}

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_user_token: the user token is missing or wrong. user_token_expired: the user token expired. Log the user in again with POST /v1/login.

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

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

{
  "error": {
    "code": "user_token_expired",
    "message": "The user token expired. Log the user in again."
  }
}

403

company_not_verified: the company is not prequalified or verified.

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

company_not_verified

{
  "error": {
    "code": "company_not_verified",
    "message": "The company must be prequalified or verified to see wholesale prices and order."
  }
}

429

rate_limit_exceeded: too many requests. Wait a moment and try again.

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

rate_limit_exceeded

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Wait a moment and try again."
  }
}

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."
  }
}

Get offers

Authorizations

Request Bodyrequired

Examples

Responses

200

Examples

400

Examples

401

Examples

403

Examples

429

Examples

500

Examples

Request Body^required