v1

latestSwagger 2.02026-08-06352151.2 KB

Usages

list usages (categories) for a product query, implicit usages included

get/products/usages

Query parameters

flatboolean

format the returned set of usages - which by default is arranged in a tree structure - as a flat list; pagination options only apply if this option is true

pageinteger

page number

per_pageinteger

items per page

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

idsstring

fetch multiple products by id using a comma separated string

imageboolean

restrict by presence of image

usages[q]string

restrict by usage search query (name)

Response

success

totalinteger

total number of items