/target/products/recommendations

POST /api/target/products/recommendations

Price: 1 credit

Get Target product recommendations for a TCIN (or product URL): similar alternatives, items other guests viewed, complementary products, deals, top-performing and new arrivals. Returns lightweight product cards with title, price, list_price, currency, save_percent, is_on_sale, image, badges, rating and rating_count, plus each recommended product's TCIN, alias and URL.

How to use it

Get a list of recommended Target products related to a given product (by TCIN or product URL). Each item is a product card with id (TCIN), title, price/list_price/currency, save_percent, is_on_sale, image, badges, rating, rating_count and alias+url. Use the returned id with the Target product endpoint to fetch full details. Set type to pick the recommendation strategy: alternatives (similar items), also_viewed (guests also viewed), complementary (goes well with), deals, top_performing, newness or similar.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Target product TCIN or a product URL containing it (examples: "91466170", "A-91466170", "https://www.target.com/p/-/A-91466170"; minLength: 1)
• count integer required — Max number of recommended products to return (min: 1)
• type string — Which recommendation strategy to return for the product (default: "alternatives"; one of: "alternatives", "also_viewed", "complementary", "deals", "top_performing", "newness", "similar")

Response

• @type string (default: "TargetRecommendationProduct")
• id string required
• url string nullable
• alias string nullable
• price number nullable
• list_price number nullable
• currency string nullable
• save_percent number nullable
• is_on_sale boolean nullable
• image string nullable
• badges array (default: [])
• rating number nullable
• rating_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 — 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.