/faire/products

POST /api/faire/products

Price: 1 credit

Get full Faire wholesale product details by token (or product URL): name, description, taxonomy type, images, retail (MSRP) price, options (SKU, GTIN, availability, weight), minimum order quantity and the brand summary.

How to use it

Fetch a single Faire product by token (p_...) or product URL. Returns one item with id, url, name, description, state, taxonomy_type, ships_from, images, video_urls, min_order_quantity, unit_multiplier, maker_best_seller, is_new, retail_price/currency (retail/MSRP), options (brand_code, gtin, retail_price, available_units, weight, min_order_quantity) and the brand (name, image, minimum_order_amount, lead time, is_top_shop, average_rating, review_count). Wholesale pricing is not available for guests. 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")
• product string required — Faire product token (e.g. 'p_wg7sfharnd') or a product URL containing it (examples: "p_wg7sfharnd", "https://www.faire.com/product/p_wg7sfharnd"; minLength: 1)

Response

• @type string (default: "FaireProduct")
• id string required
• url string required
• name string nullable
• description string nullable
• state string nullable
• taxonomy_type string nullable
• taxonomy_type_group string nullable
• ships_from string nullable
• images array (default: [])
• video_urls array (default: [])
• min_order_quantity integer nullable
• unit_multiplier integer nullable
• maker_best_seller boolean (default: false)
• is_new boolean (default: false)
• retail_price number nullable
• currency string nullable
• brand_token string nullable
• options array (default: [])
  • @type string (default: "FaireProductOption")
  • id string required
  • name string nullable
  • brand_code string nullable
  • gtin string nullable
  • retail_price number nullable
  • currency string nullable
  • available_units integer nullable
  • min_order_quantity integer nullable
  • weight number nullable
  • weight_unit string nullable
  • state string nullable
  • brand_availability string nullable
  • orderability_type string nullable
• brand object nullable
  • @type string (default: "FaireProductBrand")
  • id string required
  • name string nullable
  • image string nullable
  • minimum_order_amount number nullable
  • currency string nullable
  • published_products_count integer nullable
  • lower_bound_lead_time_days integer nullable
  • upper_bound_lead_time_days integer nullable
  • is_top_shop boolean (default: false)
  • owner_first_name string nullable
  • average_rating number nullable
  • review_count integer 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 — Product 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.