/takealot/products/search

POST /api/takealot/products/search

Price: 10 credits

Search Takealot products by keyword, or browse a department/category. Filter by brand, availability, price range (ZAR), minimum star rating and arbitrary facets, and sort by relevance, price, rating or release date. Returns product cards with title, brand, price and list price (ZAR), saving, stock status, image, rating with star distribution and review count.

How to use it

Search the Takealot (South Africa) catalog by keyword, or browse by department_slug/category_slug. Optional brand filter, in_stock_only filter, price_min/price_max (ZAR), rating (minimum star rating 1-5), a generic filters map (facet name -> value) and sort. Each result has id, product_title, alias (URL slug), subtitle, brand, url, image, image_count, price, list_price, currency, saving, is_in_stock, stock_status, has_more_colours, tsin, rating, review_count and rating_distribution.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Search keyword (examples: "iphone", "playstation 5", "coffee machine")
• count integer required — Max number of results to return (min: 1)
• sort string — Result ordering (default: "Relevance"; one of: "Relevance", "Price Ascending", "Price Descending", "Rating Descending", "ReleaseDate Descending")
• department_slug string nullable — Browse a department by its slug (examples: "computers", "cellular-gps")
• category_slug string nullable — Browse a leaf category by its slug (examples: "cellphones-26249")
• brand string nullable — Filter by brand name (examples: "Apple", "HP", "Samsung")
• in_stock_only boolean — Return only in-stock products (default: false)
• price_min integer nullable — Minimum price in ZAR (examples: 500; min: 0)
• price_max integer nullable — Maximum price in ZAR (examples: 5000; min: 0)
• rating integer nullable — Only products with at least this star rating (1-5) (examples: 4; min: 1; max: 5)
• filters object nullable — Additional facet filters as name/value pairs (facets vary per category) (examples: {"Category":"33801","Type":"16"})
  • * string

Response

• @type string (default: "TakealotSearchProduct")
• id integer required
• product_title string required
• alias string nullable
• subtitle string nullable
• brand string nullable
• url string nullable
• image string nullable
• image_count integer nullable
• price number nullable
• list_price number nullable
• currency string (default: "ZAR")
• saving string nullable
• is_in_stock boolean nullable
• stock_status string nullable
• has_more_colours boolean nullable
• tsin integer nullable
• rating number nullable
• review_count integer nullable
• rating_distribution object nullable
  • @type string (default: "TakealotRatingDistribution")
  • one_star_count integer (default: 0)
  • two_star_count integer (default: 0)
  • three_star_count integer (default: 0)
  • four_star_count integer (default: 0)
  • five_star_count integer (default: 0)

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.