POST /api/ah/products/category
Price: 10 credits
List Albert Heijn products of a category, optionally narrowed by keyword, by dietary, allergy and label properties (all of them), by Nutri-Score or to Bonus offers. Returns the same product records as ah/products.
Products of one Albert Heijn category by id from ah/categories. property_codes takes codes such as sp_include_dieet_vegetarisch, sp_include_intolerance_geen_gluten or np_biologisch and keeps products having all of them.
access-token string requiredtimeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)category string required — Category id or category page URL (examples: "1730", "https://www.ah.nl/producten/1730/zuivel-eieren"; minLength: 1)count integer required — Max number of results to return (min: 1; max: 2000)keyword string nullable — Only products matching this keyword (examples: "melk")property_codes array — Only products having all of these property codes, as keys of properties in ah/products (default: []; examples: ["sp_include_dieet_vegetarisch"], ["np_biologisch","sp_include_intolerance_geen_gluten"])nutriscore string nullable — Only products with this Nutri-Score (one of: "a", "b", "c", "d", "e")bonus_only boolean — Only products in this week's Bonus offers (default: false)@type string (default: "AhProduct")id integer requiredhq_id integer nullabletitle string nullablebrand string nullablecategory string nullablesales_unit_size string nullablealias string nullableweb_url string nullableshop_type string nullablesummary string nullablegtin string nullablegtin_revisions array (default: [])nutriscore string nullableprice number nullablelist_price number nullableunit_price number nullableunit_price_description string nullableis_bonus boolean (default: false)is_sample boolean (default: false)is_medicine boolean (default: false)is_medical_device boolean (default: false)is_orderable boolean nullableis_visible boolean nullablediscount_description string nullablepromotion_type string nullablesegment_type string nullablediscount_theme string nullableis_list_price_visible boolean nullableexternal_webshop_url string nullableimage string nullableimages array (default: [])icons array (default: [])properties object (default: {})* arraytaxonomies array (default: [])@type string (default: "AhProductTaxonomy")id integer requiredname string nullableslug string nullablepromotion_labels array (default: [])@type string (default: "AhProductPromotionLabel")top_text string nullablecenter_text string nullablebottom_text string nullabletitle string nullablevariant string nullablevariants array (default: [])@type string (default: "AhProductVariant")id integer requiredlabel string nullabletype string nullableweb_path string nullablediscount_subtitle string nullablepromotion_product_count integer nullableis_multi_item_promotion boolean nullabledescriptions array (default: [])ingredients_text string nullableallergens array (default: [])allergens_may_contain array (default: [])allergens_free_from array (default: [])allergen_ingredients array (default: [])nutrition_tables array (default: [])@type string (default: "AhProductNutritionTable")basis_quantity string nullablebasis_quantity_description string nullablepreparation_state string nullableserving_size string nullabledaily_value_reference string nullablenutrients array (default: [])@type string (default: "AhProductNutrient")code string nullablename string nullablevalue string nullabledaily_value_percent number nullablefootnotes array (default: [])@type string (default: "AhProductNutritionFootnote")label string nullablevalue string nullablenet_contents array (default: [])drained_weight string nullableserving_size string nullablecontents_description string nullablecontact_name string nullablecontact_address string nullablecontact_channels array (default: [])@type string (default: "AhProductContactChannel")channel_type string nullablevalue string nullablestorage_instructions array (default: [])usage_instructions array (default: [])feeding_instructions string nullablemarketing_description string nullablemarketing_features array (default: [])provenance array (default: [])sales_conditions 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.