Medipim BE - API V4

Developer documentation

/v4/products/query

(Last updated: 30/01/2023)

Request

Method

POST

URL

https://api.medipim.be/v4/products/query

Headers

Body

Filter Description Parameters Examples
{"id": ...} Matches by product ID. One or more Medipim product IDs {"id": 1} or {"id": [1, 2]}
{"status": ...} Matches products by status. One or more product statuses.
Possible values: "active", "replaced" or "inactive".
{"status": "active"} or {"status": ["replaced", "inactive"]}
{"ecommerce": ...} Matches products by ecommerce status. One or more ecommerce statuses.
Possible values: "yes", "no" or "unknown".
{"ecommerce": "yes"} or {"ecommerce": ["yes", "unknown"]}
{"organization": ...} Matches products by organization. One or more organization IDs. {"organization": 2} or {"organization": [2, 15]}
{"publicCategory": ...} Matches products by public category. One or more public category IDs. {"publicCategory": 12} or {"publicCategory": [3, 6]}
{"brand": ...} Matches products by brand. One or more brand IDs. {"brand": 4} or {"brand": [14, 3]}
{"search": ...} Matches products by a specific search query. Array with 'query' and 'locale' key. {"search": {"query": "test", "locale": "nl"}}
{"minimumContent": ...} Matches products that have at least one photo or one description. true or false. {"minimumContent": true} or {"minimumContent": false}
{"hasContent": ...} Matches products that have specific content. Array with 'flag' and 'locale' key {"hasContent": {"flag": "name", "locale": "nl"}
{"ean": ...} Matches products with specified EAN number. String. {"ean": "3574660696318"} or {"ean": ["3574660696318", "3401526293056", ...]}
{"gtin": ...} Matches products with specified GTIN number. String. {"gtin": "03664798014846"} or {"gtin": ["03664798014846", "07613326014816", ...]}
{"hsCode": ...} Matches products with specified HS code. Integer. {"hsCode": "010203"} or {"hsCode": ["010203", "010204", ...]}
{"activeIngredient": ...} Matches products by active ingredients. One or more activeIngredient IDs. {"activeIngredient": [1, 2]}
{"conservation": ...} Matches products by conservation. One or more conservation types.
Possible values: "room", "refrigerator", "fresh" or "frozen".
{"conservation":"room"} or {"conservation": ["room", "frozen", ...]}
{"allowedSpecies": ...} Matches products by allowed species. One or more species
Possible values: "human", "veterinary", "surface_maintenance" or "phytopharmacy".
{"allowedSpecies":"human"} or {"allowedSpecies": ["human", "veterinary", ...]}
{"cnk": ...} Matches products by CNK. One or more CNKs {"cnk": "4444444"} or {"cnk": ["1234567", "4444444"]}
{"apbCategory": ...} Matches products by APB category. One or more APB categories
Possible values: "specialty", "homeopathy", "ostomy_incontinence", "bandages_related", "reactive", "hygiene", "cosmetics", "diet_nutrition", "other", "biocide", "medical_device", "accessory", "pesticides_agricultural", "diagnostic_tool", "unknown" or "material"
{"apbCategory":"homeopathy"} or {"apbCategory": ["material", "reactive"]}
{"atcCategory": ...} Matches products with specified ATC category code. String. {"atcCategory": "BC01D"}
{"cti": ...} Matches products with specified CTI number. String. {"cti": "240904"}
{"bcfiCategory": ...} Matches products by BCFI category. One or BCFI category IDs. {"bcfiCategory": "0017566"} or {"bcfiCategory": ["0017566", "0000976"]}
{"prescription": ...} Matches products with or without prescription . true or false. {"prescription": true} or {"prescription": false}
{"writtenRequestByPatient": ...} Matches products with or without request written by patient . true or false. {"writtenRequestByPatient": true} or {"writtenRequestByPatient": false}
{"createdAt": ...} Matches products created since the given time. Unix timestamp. {"createdAt": 1471525605} or {"createdAt": {"from": 1471525605, "until": 1571525605}}
{"updatedSince": ...} Matches products updated since the given time. Unix timestamp. {"updatedSince": 1471525605} or {"updatedSince": {"from": 1471525605, "until": 1571525605}}
{"and": [...]} Matches products that match all of the given filters. A list of filters. {"and": [{"brand": [24, 65, ...]}, {"status": "active"}]}
{"or": [...]} Matches products that match any of the given filters. A list of filters. {"or": [{"publicCategory": [2, 16, ...]}, {"status": "active"}]}
{"not": ...} Matches products that do not match the given filter. A filter. {"not": {"publicCategory": 81}}
Sorting Description Parameters Examples
{"id": ...} Sort by Medipim ID "ASC" or "DESC" {"id": "ASC"} or {"id": "DESC"}
{"name": ...} Sort by name Array containing "direction" and "locale" {"name": {"direction": "ASC", "locale": "fr"}} or ...
{"cnk": ...} Sort by CNK "ASC" or "DESC" {"cnk": "ASC"} or {"cnk": "DESC"}
{"createdAt": ...} Sort by created time "ASC" or "DESC" {"createdAt": "ASC"} or {"createdAt": "DESC"}
{"touchedAt": ...} Sort by last updated time "ASC" or "DESC" {"touchedAt": "ASC"} or {"touchedAt": "DESC"}
{"statusTouchedAt": ...} Sort by status last updated time "ASC" or "DESC" {"statusTouchedAt": "ASC"} or {"statusTouchedAt": "DESC"}
{"status": ...} Sort by status "ASC" or "DESC" {"status": "ASC"} or {"status": "DESC"}

Tip

The maximum amount of CNK codes or IDs provided cannot exceed 1000.
If your query contains more than 1000, please break it down into multiple requests with smaller sets.

Response

Body

Note

The maximum number is limited to 10000; use the stream endpoint to get all results

The same media item (photos, frontals and links) can be linked to multiple products

Tip

If no images are available in the language you need, we advise to use the following fallbacks:

  • for NL: try 'fr', then 'en', then other locales
  • for FR: try 'nl', then 'en', then other locales
  • for EN: try 'nl', then other locales

Examples