Medipim API V3

Developer documentation

POST /v3/products/search

(last updated July 2019)

Request

Method

POST

URL

https://api.medipim.be/v3/products/search

Headers

Body

Filter Description Parameters Examples
{"id": ...} Matches products by Medipim ID. One or more Medipim ID(s) {"id": "M12345ABCD"} or {"id":["M12345ABCD", "M54321DCBA"]}
{"cnk": ...} Matches products by CNK. One or more CNKs {"cnk": "4444444"} or {"cnk": ["1234567", "4444444"]}
{"status": ...} Matches products by status. One or more product statuses.
Possible values: "active", "replaced" or "inactive".
{"status": "active"} or {"status": ["replaced", "inactive"]}
{"apbCategory": ...} Matches products by APB category. One or more APB category IDs. {"apbCategory":"homeopathy"} or {"apbCategory": ["material", "reactive"]}
{"conservation": ...} Matches products by conservation. One or more conservation types. {"conservation":"room"} or {"conservation": ["room", "frozen", ...]}
{"publicCategory": ...} Matches products by public category. One or more public category IDs. {"publicCategory": 12} or {"publicCategory": [3, 6]}
{"bcfiCategory": ...} Matches products by BCFI category. One or BCFI category IDs. {"bcfiCategory": "0017566"} or {"bcfiCategory": ["0017566", "0000976"]}
{"productFamily": ...} Matches products by Product Family Association Identifier. One or Product family association IDs. {"productFamily": "0017566"} or {"productFamily": ["0017566", "0000976"]}
{"brand": ...} Matches products by brand. One or more brand IDs. {"brand": 4} or {"brand": [14, 3]}
{"organization": ...} Matches products by organization. One or more organization IDs. {"organization": 2} or {"organization": [2, 15]}
{"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}
{"minimumContent": ...} Matches products that have at least one photo or one description. true or false. {"minimumContent": true} or {"minimumContent": false}
{"updatedSince": ...} Matches products updated since the given time. Unix timestamp. {"updatedSince": 1471525605}
{"cti": ...} Matches products with specified cti number. String. {"cti": "240904"}
{"activeIngredient": ...} Matches products by active ingredients. One or more activeIngredient IDs. {"activeIngredient": [1, 2]}
{"search": ...} Matches products by a specific search query. Array with 'query' and 'locale' key. {"search": {"query": "test", "locale": "nl"}}
{"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"}
{"cnk": ...} Sort by CNK "ASC" or "DESC" {"cnk": "ASC"} or {"cnk": "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

Examples