/vestiairecollective/products/search

POST /api/vestiairecollective/products/search

Price: 20 credits

Search Vestiaire Collective listings by free text with designer, model, category, size, material, color, condition, location, price, discount, seller badge and availability filters, for any shopper country, currency and language

How to use it

Search Vestiaire Collective listings; sold listings are included unless is_sold is false, so set it to browse only what is for sale. Designer ids come from the Vestiaire Collective designer search endpoint, and category, model, subcategory ids and size codes from returned products. The country changes ranking and prices; prices and the price filter are in the requested currency.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• country string — ISO code of the shopper country the listings are priced and ranked for (default: "US"; one of: "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BR", "BS", "BT", "BV", "BW", "BZ", "CA", "CC", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"; examples: "US", "FR", "GB", "JP")
• currency string nullable — Currency of every price and of the price filters; defaults to the country's own currency where it is one of these, otherwise USD (one of: "EUR", "USD", "GBP", "HKD", "SGD", "AUD", "CAD", "PLN", "CHF", "SEK", "DKK", "JPY", "KRW"; examples: "EUR", "GBP")
• language string — Language of names, descriptions and category labels (default: "en"; one of: "en", "fr", "de", "it", "es", "nl", "sv", "ko")
• count integer required — Max number of products to return (min: 1; max: 1250)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "newest")
• universes array nullable — Women, men or kids (one of: "women", "men", "kids")
• designer_ids array nullable — Designer ids, as designer.id in returned products (examples: ["2"], ["50","17"])
• model_ids array nullable — Model ids, as model.id in returned products (examples: ["887"])
• base_category_ids array nullable — Top-level category ids, as base_category.id in returned products (examples: ["5"])
• category_ids array nullable — Category ids, as category.id in returned products (examples: ["59"])
• subcategory_ids array nullable — Subcategory ids, as subcategory.id in a product (examples: ["199"])
• sizes array nullable — Size codes, as size_codes in returned products; a listing matching any of them is returned (examples: ["M#3"], ["M#3","L#4"])
• materials array nullable — Main materials (one of: "cashmere", "cotton", "leather", "suede", "denim_jeans", "fur", "wool", "linen", "silk", "synthetic", "viscose", "other", "rubber", "patent_leather", "plastic", "cloth", "wicker", "tweed", "velvet", "silver", "wood", "pearl", "metal", "white_gold", "yellow_gold", "pink_gold", "silver_plated", "gold_plated", "glass", "platinum", "silver_gilt", "steel", "gold", "ceramic", "glitter", "chain", "spandex", "lace", "lycra", "polyamide", "sponge", "pearls", "cotton_elasthane", "polyester", "jade", "porcelain", "pony_style_calfskin", "faux_fur", "exotic_leathers", "titanium", "gold_and_steel", "crystal", "vegan_leather", "not_specified", "vinyl", "coral")
• colors array nullable — Colors (one of: "white", "beige", "yellow", "orange", "pink", "red", "purple", "brown", "blue", "green", "khaki", "grey", "black", "silver", "gold", "multicolour", "other", "charcoal", "ecru", "burgundy", "metallic", "camel", "navy", "turquoise")
• conditions array nullable — Item conditions (one of: "never_worn_with_tag", "never_worn", "very_good", "good", "fair")
• watch_mechanisms array nullable — Watch movements (one of: "manual_winding", "quartz", "automatic", "smartwatch", "not_specified")
• country_codes array nullable — ISO country codes of where the item is located (examples: ["US"], ["FR","IT"])
• min_price number nullable — Minimum price in the requested currency (min: 0)
• max_price number nullable — Maximum price in the requested currency (min: 0)
• discounts array nullable — Discount levels (one of: "20%", "30%", "40%", "50%")
• editor_picks array nullable — Editorial selections (one of: "we_love", "vintage", "exceptional_pieces")
• seller_badges array nullable — Seller badges (one of: "trusted", "expert")
• is_sold boolean nullable — Only sold items when true, only unsold when false
• is_in_stock boolean nullable — Only express-delivery items held in Vestiaire Collective stock when true, none of them when false
• is_official_store boolean nullable — Only official brand stores when true, none of them when false
• is_duty_free boolean nullable — Only duty-free items when true, none when false
• is_deal boolean nullable — Only deal items when true, none when false
• query string nullable — Free-text search (examples: "jackie bag", "chanel tweed jacket"; minLength: 1)

Response

• @type string (default: "VestiaireProductCard")
• id string required
• name string nullable
• description string nullable
• url string nullable
• price number nullable
• currency string nullable
• original_price number nullable
• discount_percent number nullable
• designer object nullable
  • @type string (default: "VestiaireRef")
  • id string required
  • name string nullable
• model object nullable
  • @type string (default: "VestiaireRef")
  • id string required
  • name string nullable
• condition object nullable
  • @type string (default: "VestiaireRef")
  • id string required
  • name string nullable
• base_category object nullable
  • @type string (default: "VestiaireRef")
  • id string required
  • name string nullable
• category object nullable
  • @type string (default: "VestiaireRef")
  • id string required
  • name string nullable
• size object nullable
  • @type string (default: "VestiaireRef")
  • id string required
  • name string nullable
• size_codes array (default: [])
• colors array (default: [])
  • @type string (default: "VestiaireRef")
  • id string required
  • name string nullable
• primary_color_id string nullable
• universe string nullable
• country_code string nullable
• images array (default: [])
• like_count integer nullable
• is_sold boolean nullable
• is_gone boolean nullable
• is_in_stock boolean nullable
• is_local_eligible boolean nullable
• is_direct_shipping boolean nullable
• is_duty_free boolean nullable
• is_vintage boolean nullable
• is_we_love boolean nullable
• is_hot boolean nullable
• is_deal boolean nullable
• is_exceptional boolean nullable
• seller object nullable
  • @type string (default: "VestiaireCardSeller")
  • id string required
  • name string nullable
  • badge string nullable
  • image string nullable
  • is_official_store boolean nullable
• created_at 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 — 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.