Skip to main content
POST
/faire/products/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
query
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
country
enum<string>
default:USA
Available options:
USA,
GBR,
AUS,
FRA,
DEU,
ITA,
ESP,
NLD,
PRT,
SWE,
DNK
categories
string[]
product_types
string[]
brands
string[]
brand_values
enum<string>[]
Available options:
asian_owned,
black_owned,
deaf_owned,
disability_owned,
eco_friendly,
gives_back,
hand_made,
indigenous_owned_usa,
latino_owned,
lgbtq_owned,
not_sold_on_amazon,
organic,
women_owned
ships_from
enum<string>[]
Available options:
usa,
gbr,
can,
aus,
european_union,
rest_of_europe,
africa,
asia,
oceania,
south_america
made_in
enum<string>[]
Available options:
usa,
gbr,
can,
aus,
european_union,
rest_of_europe,
africa,
asia,
oceania,
south_america
lead_time
enum<string> | null
Available options:
three_or_less_days,
six_or_less_days,
nine_or_less_days,
fourteen_or_less_days
new_this_month
boolean
default:false
has_gtin
boolean
default:false

Response

Successful Response

id
string
required
url
string
required
@type
string
default:FaireSearchProduct
name
string | null
brand_token
string | null
is_new
boolean
default:false
maker_best_seller
boolean
default:false
is_bestseller
boolean
default:false
has_active_brand_promo
boolean
default:false
avg_brand_review_rating
number | null
brand_review_count
integer | null
retail_price
number | null
currency
string | null
based_in_country
string | null
image
string | null
state
string | null