POST /api/ah/bonus
Price: 10 credits
List this week's Albert Heijn Bonus offers: title, category, offer labels, price and price before the offer, validity period, image, the products each offer covers and whether it is store-only.
This week's Albert Heijn Bonus offers, optionally of one category_id. period_start and period_end are unix timestamps; product_count is the number of products an offer covers and product_ids the product ids the source lists with it, each usable with ah/products; on some multi-product offers product_ids holds fewer ids than product_count.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)count integer required — Max number of results to return (min: 1)category string nullable — Only offers of this Bonus category, by its category_id (examples: "groente-aardappelen", "GALL")@type string (default: "AhBonusPromotion")id string requiredtitle string nullablesubtitle string nullablecategory_id string nullablecategory string nullablecategory_type string nullablecategory_taxonomy_id integer nullableurl string nullableimage string nullableprice number nullablelist_price number nullableexample_text string nullableexception_rule string nullableextra_descriptions array (default: [])labels array (default: [])@type string (default: "AhBonusLabel")top_text string nullablecenter_text string nullablebottom_text string nullabletitle string nullablevariant string nullablepromotion_type string nullablesegment_type string nullableactivation_status string nullableperiod_description string nullableperiod_start integer nullableperiod_end integer nullableis_store_only boolean nullableproduct_count integer nullableproduct_id integer nullableproduct_title string nullableproduct_brand string nullableproduct_url string nullableproduct_ids array (default: [])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.X-Error — Error message text (present only on error)X-Request-ID — Unique request identifierX-Execution-Time — Execution time in secondsX-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.