/faire/brands/search

POST /api/faire/brands/search

Price: 5 credits

List Faire brands (suppliers), optionally within a category via navigation_path, with filters (brand values, ships-from, lead time, American brands, sort). Returns brand cards with minimum order amount, location, lead time, product counts and rating.

How to use it

List Faire brands (suppliers). Use navigation_path to browse a category (default 'All Brands'). Filter by brand_values, ships_from, lead_time, american_brands (based in the session country) and sort. Each result has id, url, name, image, minimum_order_amount/currency, based_in_country, ships_from_country, lead time, active_products_count, new_products_count, categories, is_top_shop, average_rating, review_count and maker_values. Use the country field for non-US markets.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string — Faire marketplace country. Determines currency, catalog and localization. (default: "USA"; one of: "USA", "GBR", "AUS", "FRA", "DEU", "ITA", "ESP", "NLD", "PRT", "SWE", "DNK")
• navigation_path string — Brand navigation path (category label), e.g. 'All Brands', 'Home decor', 'Beauty & wellness' (default: "All Brands")
• count integer required — Max number of brands to return (min: 1)
• brand_values array — Filter by brand values (default: []; one of: "eco_friendly", "hand_made", "not_sold_on_amazon", "organic", "women_owned")
• ships_from array — Filter by brand ships-from location (default: []; one of: "usa", "gbr", "can", "aus", "european_union", "rest_of_europe", "africa", "asia", "oceania", "south_america")
• lead_time string nullable — Maximum lead time (one of: "three_or_less_days", "six_or_less_days", "nine_or_less_days", "fourteen_or_less_days")
• american_brands boolean — Only brands based in the session country (e.g. American brands for USA) (default: false)
• sort string nullable — Result ordering (one of: "score_desc", "first_active_at_desc", "minimum_asc", "name_asc", "name_desc")

Response

• @type string (default: "FaireSearchBrand")
• id string required
• url string required
• name string nullable
• image string nullable
• minimum_order_amount number nullable
• currency string nullable
• based_in_country string nullable
• ships_from_country string nullable
• lower_bound_lead_time_days integer nullable
• upper_bound_lead_time_days integer nullable
• active_products_count integer nullable
• new_products_count integer nullable
• categories string nullable
• is_top_shop boolean (default: false)
• is_zip_code_protection_enabled boolean (default: false)
• has_new_products boolean (default: false)
• average_rating number nullable
• review_count integer nullable
• maker_values array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.