/target/products/search

POST /api/target/products/search

Price: 20 credits

Search Target products by keyword. Returns lightweight product cards: title, brand, price, list_price, currency, save_percent, is_on_sale, image, rating and rating_count, the browse-node ids the product sits under (category_id, parent_category_id), plus the product TCIN, alias and URL. Supports ordering by relevance, price, rating, newest, bestselling or featured.

How to use it

Search the Target catalog by keyword and get a list of matching product cards. Each item has id (TCIN), title, brand, price/list_price/currency, save_percent, is_on_sale, image, rating, rating_count, category_id and parent_category_id (browse nodes usable with the Target category listing endpoint) and alias+url. Use the returned id with the Target product endpoint to fetch full product details. Set sort to order results (relevance, price_low, price_high, rating, newest, bestselling, featured).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Search keyword (examples: "laptop", "running shoes"; minLength: 1)
• count integer required — Max number of products to return (min: 1; max: 1200)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "featured", "price_low", "price_high", "rating", "bestselling", "newest")

Response

• @type string (default: "TargetProductCard")
• id string required
• url string nullable
• alias string nullable
• title string nullable
• brand string nullable
• price number nullable
• list_price number nullable
• currency string nullable
• save_percent number nullable
• is_on_sale boolean nullable
• image string nullable
• rating number nullable
• rating_count integer nullable
• category_id string nullable
• parent_category_id string 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.