Sign in

v1

latestSwagger 2.02026-08-06352151.2 KB
Products

list products

get/products

Query parameters

locale'nl' | 'en'

prefer content in a specific language

pageinteger

page number

per_pageinteger

items per page

detail'list' | 'default' | 'health' | 'biz_list' | 'biz'

detail level (biz_list and biz require owner)

qstring

search query (name, brand or barcode)

usage_idinteger

restrict by usage (category)

usage_ids[]string[]

restrict to usages

category_idinteger

restrict by usage (category); deprecated in favor of usage_id

brand_idinteger

restrict to brand

brand_ids[]integer[]

restrict to brands

retailer_idinteger

restrict to retailer

retailer_ids[]integer[]

restrict to retailers

health_group_idinteger

restrict to health group

health_group_presenttrue

restrict to products that belong to a health group

certificate_idinteger

restrict to certificate

certificate_ids[]integer[]

restrict to certificates

scoredtrue

require a published health score

personal_health_scoredboolean

require a published health score

scoreinteger

deprecated: an empty list is returned for any value

nutriscore'A' | 'B' | 'C' | 'D' | 'E'

restrict by Nutriscore

nutriscores[]string[]

restrict by Nutriscores

personal_health_score'A' | 'B1' | 'B2' | 'C1' | 'C2'

restrict by health score

personal_health_scores[]string[]

restrict by health scores

sort'confirmed_at' | 'confirmed_at ASC' | 'name' | 'name DESC' | 'last_updated' | 'last_updated ASC' | 'nutrient_B12' | 'nutrient_B12 DESC' | 'nutrient_calcium' | 'nutrient_calcium DESC' | 'nutrient_energy' | 'nutrient_energy DESC' | 'nutrient_fat_saturated' | 'nutrient_fat_saturated DESC' | 'nutrient_fat_total' | 'nutrient_fat_total DESC' | 'nutrient_fat_trans' | 'nutrient_fat_trans DESC' | 'nutrient_fiber' | 'nutrient_fiber DESC' | 'nutrient_iron' | 'nutrient_iron DESC' | 'nutrient_natrium' | 'nutrient_natrium DESC' | 'nutrient_protein' | 'nutrient_protein DESC' | 'nutrient_salt' | 'nutrient_salt DESC' | 'nutrient_sugar' | 'nutrient_sugar DESC' | 'nutriscore' | 'nutriscore DESC' | 'personal_health_score' | 'personal_health_score DESC' | 'top_certificates_count' | 'top_certificates_count DESC'

sorting order, default value is "name", unless q is given, then the default order is determined by search rank

idsstring

fetch multiple products by id using a comma separated string

package_size_mininteger

require a minimum package size (≥) in grams or milliliters

package_size_maxinteger

require a maximum package size (≤) in grams or milliliters

package_size_unit'g' | 'ml'

restrict by package size unit

imageboolean

restrict by presence of image

Response

success

totalinteger

total number of items