/ah/products/search

POST /api/ah/products/search

Price: 10 credits

Search Albert Heijn products by keyword. Returns product cards with title, brand, category, price, list price, nutriscore, bonus/discount info, unit price description, availability and images.

How to use it

Keyword search across the Albert Heijn catalog. Each result has id, title, brand, main_category, sub_category, shop_type, sales_unit_size, unit_price_description, nutriscore, price, list_price (price before bonus when discounted), min_best_before_days, is_bonus/is_sponsored/is_nix18, bonus_mechanism/bonus_start_date/bonus_end_date, discount_labels, virtual bundle info, order_availability_status, description, description_highlights, property_icons and image/images.

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: "melk", "koffie", "pindakaas"; minLength: 1)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "AhSearchProduct")
• id integer required
• hq_id integer nullable
• brand string nullable
• main_category string nullable
• sub_category string nullable
• shop_type string nullable
• sales_unit_size string nullable
• unit_price_description string nullable
• nutriscore string nullable
• price number nullable
• list_price number nullable
• min_best_before_days integer nullable
• is_bonus boolean (default: false)
• is_sponsored boolean (default: false)
• is_orderable boolean nullable
• is_available_online boolean nullable
• is_sample boolean (default: false)
• is_nix18 boolean (default: false)
• is_stapel_bonus boolean (default: false)
• is_infinite_bonus boolean (default: false)
• is_virtual_bundle boolean (default: false)
• bonus_mechanism string nullable
• bonus_start_date string nullable
• bonus_end_date string nullable
• promotion_type string nullable
• order_availability_status string nullable
• description string nullable
• description_highlights string nullable
• image string nullable
• images array (default: [])
• property_icons array (default: [])
• discount_labels array (default: [])
  • @type string (default: "AhSearchDiscountLabel")
  • code string nullable
  • description string nullable
  • amount number nullable
  • percentage number nullable
  • precise_percentage number nullable
  • price number nullable
  • count integer nullable
  • free_count integer nullable
  • unit string nullable
• virtual_bundle_items array (default: [])
  • @type string (default: "AhVirtualBundleItem")
  • product_id integer required
  • quantity 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.