/faire/brands

POST /api/faire/brands

Price: 1 credit

Get full Faire brand (supplier) details by token (or brand URL): name, description, images, location, brand values, minimum order amounts, lead time, ratings and review metrics.

How to use it

Fetch a single Faire brand (supplier) by token (b_...) or brand URL. Returns one item with id, url, name, description, image/squared_image/banner_image, is_top_shop, based_in_country/state/city, ships_from_country, made_in, primary_category, sold_on_amazon, value flags (eco_friendly, hand_made, charitable, organic, women_owned, small_batch), is_zip_code_protection_enabled, minimum_order_amount/first_order_minimum_amount/reorder_minimum_amount/currency, lead time, owner_first_name, creation_year, instagram_handle, active_products_count, average_rating, review_count and review_metrics. 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")
• brand string required — Faire brand token (e.g. 'b_mmdanrh9jf') or a brand URL containing it (examples: "b_mmdanrh9jf", "https://www.faire.com/brand/b_mmdanrh9jf"; minLength: 1)

Response

• @type string (default: "FaireBrand")
• id string required
• url string required
• name string nullable
• description string nullable
• image string nullable
• squared_image string nullable
• banner_image string nullable
• is_top_shop boolean (default: false)
• based_in_country string nullable
• based_in_state string nullable
• based_in_city string nullable
• ships_from_country string nullable
• made_in string nullable
• primary_category string nullable
• is_zip_code_protection_enabled boolean (default: false)
• sold_on_amazon boolean (default: false)
• eco_friendly boolean (default: false)
• hand_made boolean (default: false)
• charitable boolean (default: false)
• organic boolean (default: false)
• women_owned boolean (default: false)
• small_batch boolean (default: false)
• minimum_order_amount number nullable
• first_order_minimum_amount number nullable
• reorder_minimum_amount number nullable
• currency string nullable
• lead_time_days integer nullable
• lower_bound_lead_time_days integer nullable
• upper_bound_lead_time_days integer nullable
• owner_first_name string nullable
• creation_year integer nullable
• instagram_handle string nullable
• active_products_count integer nullable
• has_new_products boolean (default: false)
• average_rating number nullable
• review_count integer nullable
• review_metrics array (default: [])
  • @type string (default: "FaireBrandMetric")
  • name string required
  • label string nullable
  • average_rating number nullable

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 — Brand not found (well-formed but nonexistent token) 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.