/ah/products

POST /api/ah/products

Price: 1 credit

Get full Albert Heijn product details by product id (or product URL): title, brand, category, sales unit size, summary, price, unit price, nutriscore, bonus/discount info, images, taxonomy, product properties and variants.

How to use it

Fetch a single Albert Heijn product by id (e.g. wi441199 / 441199) or a product URL. Returns one item with title, brand, category, sales_unit_size, alias, web_url, summary, nutriscore, price, list_price (original price when discounted), unit_price/unit_price_description, is_bonus and discount details, image/images, icons, properties (raw property codes), taxonomies (category hierarchy), promotion_labels and variants.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• product string required — Albert Heijn product id or a product URL containing it (examples: "wi441199", "441199", "https://www.ah.nl/producten/product/wi441199/campina-halfvolle-melk-voordeelverpakking"; minLength: 1)

Response

• @type string (default: "AhProduct")
• id integer required
• hq_id integer nullable
• brand string nullable
• category string nullable
• sales_unit_size string nullable
• alias string nullable
• web_url string nullable
• shop_type string nullable
• summary string nullable
• nutriscore string nullable
• price number nullable
• list_price number nullable
• unit_price number nullable
• unit_price_description string nullable
• is_bonus boolean (default: false)
• is_sample boolean (default: false)
• is_medicine boolean (default: false)
• is_medical_device boolean (default: false)
• is_orderable boolean nullable
• is_visible boolean nullable
• discount_description string nullable
• promotion_type string nullable
• segment_type string nullable
• discount_theme string nullable
• is_list_price_visible boolean nullable
• external_webshop_url string nullable
• image string nullable
• images array (default: [])
• icons array (default: [])
• properties object (default: {})
  • * array
• taxonomies array (default: [])
  • @type string (default: "AhProductTaxonomy")
  • id integer required
  • name string nullable
  • slug string nullable
• promotion_labels array (default: [])
  • @type string (default: "AhProductPromotionLabel")
  • top_text string nullable
  • center_text string nullable
  • bottom_text string nullable
  • variant string nullable
• variants array (default: [])
  • @type string (default: "AhProductVariant")
  • id integer required
  • label string nullable
  • type string nullable
  • web_path 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 — Product not found (well-formed but nonexistent id) 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.