/thredup/products/similar

POST /api/thredup/products/similar

Price: 20 credits

List ThredUp listings similar to a given item, narrowed by department, category, brand, price, condition, color, material, pattern and accent

How to use it

Find ThredUp listings similar to one item number, as returned in id by the ThredUp product search or product endpoints. Each result's own id is in turn accepted back by the ThredUp product and similar endpoints, but not by product search, which takes no item id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• excluded_departments array nullable — Departments to leave out (one of: "women", "girls", "boys", "shoes", "handbags", "accessories", "jewelry", "maternity", "petite", "tall", "juniors", "plus", "premium", "designer"; examples: ["shoes","handbags","accessories","jewelry"])
• categories array nullable — Category tags from the ThredUp categories endpoint (examples: ["dresses","tops"])
• brands array nullable — Brand names from the ThredUp brands endpoint (examples: ["J.Crew","Madewell"])
• styles array nullable — Style tags from the ThredUp categories endpoint or product styles (examples: ["watches"])
• is_luxe_only boolean — Only luxury-brand listings when true (default: false)
• min_price number nullable — Minimum price in USD (min: 0)
• max_price number nullable — Maximum price in USD (min: 0)
• conditions array nullable — Item conditions (one of: "new_with_tags", "excellent", "very_good", "good", "flawed_gem")
• colors array nullable — Colors (one of: "black", "grey", "white", "ivory", "tan", "brown", "purple", "blue", "teal", "green", "red", "pink", "orange", "yellow")
• materials array nullable — Material groups (one of: "natural", "cashmere", "cotton", "linen", "silk", "wool", "leather", "suede", "blend", "cashmere_blend", "cotton_blend", "linen_blend", "silk_blend", "wool_blend", "synthetic", "acrylic", "faux_fur", "nylon", "polyester", "rayon", "spandex", "vegan_leather")
• patterns array nullable — Patterns (one of: "animal_print", "argyle", "camo", "checkered_gingham", "chevron_herringbone", "color_block", "floral", "graphic", "hearts", "houndstooth", "metallic", "paisley", "plaid", "polka_dots", "print", "solid", "stars", "stripes", "tie_dye", "tropical", "tweed")
• accents array nullable — Accents and details (one of: "beaded", "bows", "chains", "cut_outs", "embroidered", "flannel", "frayed_edges", "fringe", "fur", "glitter", "lace_up", "peplum", "ripped", "ruched", "ruffles", "sequins_rhinestones", "shearling", "studded", "velvet", "zippers")
• product string required — ThredUp item number or product URL (examples: "236674693", "https://www.thredup.com/similar/236674693"; minLength: 1)
• count integer required — Max number of products to return (min: 1; max: 10000)
• departments array nullable — Departments to keep (one of: "women", "girls", "boys", "shoes", "handbags", "accessories", "jewelry", "maternity", "petite", "tall", "juniors", "plus", "premium", "designer"; examples: ["women"])
• sort string — Result ordering (default: "relevance"; one of: "relevance", "newest", "price_low_high", "price_high_low", "recently_marked_down")

Response

• @type string (default: "ThredupProductCard")
• id string required
• url string required
• internal_id string nullable
• description string nullable
• brand string nullable
• brand_id string nullable
• brand_style_name string nullable
• category string nullable
• category_tags array (default: [])
• department string nullable
• departments array (default: [])
• gender string nullable
• price number nullable
• msrp number nullable
• original_price number nullable
• savings number nullable
• currency string (default: "USD")
• promotion object nullable
  • @type string (default: "ThredupPromotion")
  • code string nullable
  • discount_percent number nullable
  • price number nullable
  • is_dynamic_discount boolean nullable
• condition string nullable
• is_new_with_tags boolean nullable
• is_clearance boolean nullable
• is_p2p boolean nullable
• availability string nullable
• state string nullable
• size string nullable
• size_ids array (default: [])
• colors array (default: [])
• materials array (default: [])
• styles array (default: [])
• access_levels array (default: [])
• favorite_count integer nullable
• mpn_title string nullable
• supplier_id string nullable
• original_supplier_id string nullable
• warehouse_id string nullable
• cluster_id string nullable
• cluster_item_count integer nullable
• similar_search_filters object nullable
  • @type string (default: "ThredupSimilarFilters")
  • departments array (default: [])
  • categories array (default: [])
  • size_ids array (default: [])
• image string nullable
• images 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 — No ThredUp listing has this item number 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.