/v4/products/query
(Last updated: 25/09/2023)
Request
Method
POST
URL
https://api.medipim.be/v4/products/query
Headers
Body
filter
: one of the filters below; filters can be combined usingand
,or
¬
. (required)sorting
: one of the sortings below. (required)page
(required)no
: page number (zero-based)size
: one of 10, 50, 100 or 250 (defaults to 100)
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 explanation for more information | {"hasContent": {"flag": "name", "locale": "nl"} |
{"ean": ...} |
Matches products with specified EAN number. More info | String. | {"ean": "3574660696318"} or {"ean": ["3574660696318", "3401526293056", ...]} |
{"gtin": ...} |
Matches products with specified GTIN number. More info | 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 More info | {"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 identifier codes (CNK, Medipim ID, ...) 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
meta
total
: total results across all pages. (integer)page
no
: page number (zero-based) (integer)offset
: offset of the first product in the entire resultset (integer)size
: size of the page (integer)
results[]
: a list of matching products on this page.id
: Medipim ID (string, unique)status
: Product status ("active"
,"replaced"
or"inactive"
)ecommerce
: Whether a product can be sold online or not ("yes"
,"no"
or"unknown"
)replacement
: Medipim ID of the replacing product (only in case product status is"replaced"
) (string)name.{nl|fr|...}
: Name (string, localized)seoName.{nl|fr|...}
: SEO friendly name (string, localized)shortDescription.{nl|fr|...}
: Short description (string, localized). (⚠️ field is not used anymore)prescription
: Whether or not the product requires a prescription. (boolean)writtenRequestByPatient
: Written request by patient. (boolean)requiresLegalText
: Product requires a legal text (description) to be displayed. (boolean)officialDeletionAt
: Official date on which the product became unavailable. (timestamp)cnk
: CNK code (string)ean[]
: EAN codes (integer[])udi
: UDI code (string)nut
: NUT code (string)atc
: ATC code (string) (⚠️ deprecated use atcCategory instead)atcCategory[]
: List of ATC category codes associated with this product (string[])gtin
: GTIN code (string)hsCode
: Harmonised System (HS) code (integer)ctiExtended
: Extended CTI code (string)conservation
: Conservation for a given product. (string) Possible values:room
,refrigerator
,fresh
,frozen
publicPrice
: Public price (integer, in EUR cents) (⚠️value is including VAT)manufacturerPrice
: Manufacturer price (integer, in EUR cents) (⚠️value is excluding VAT)pharmacistPrice
: Pharmacist price (integer, in EUR cents) (⚠️value is excluding VAT)vat
: rate of VAT (float)refundValueWithOmnio
: Refund value with Omnio status (⚠️value is including VAT)refundValueWithoutOmnio
: Refund value without Omnio status (⚠️value is including VAT)weight
: Weight (integer, in grams)width
: Width (integer, in millimeters)length
: Length (integer, in millimeters)depth
: Depth (integer, in millimeters)packageContent
: Package Content (string)packageQuantity
: Package Quantity (string)packagingUnit
: Packaging unit (string)bcfiCategory
: BCFI category this product belongs to (if any) | GET /v4/bcfi-categories/query responseid
: ID of the category (string)parent
: ID of the parent category (string)order
: Sort order of the category (int)name.{nl|fr|...}
: name of the category (string, localized)meta
:createdAt
: When the category was created on Medipim (unix timestamp)updatedAt
: When the category was last updated (unix timestamp)
apbCategory
: APB category this product belongs to (if any)id
: ID of the category (string)name.{nl|fr|...}
: name of the category (string, localized)
publicCategories[]
: A collection of public categories this product belongs to. | GET /v4/public-categories/query responseid
: ID of the category (integer)name.{nl|fr|...}
: Name of the category (string, localized)parent
: ID of the parent category (integer)meta
:createdAt
: When the category was created on Medipim (unix timestamp)updatedAt
: When the category information was last updated (unix timestamp)
brands[]
: A collection of brands associated with this product. | POST /v4/brands/query responseid
: ID of the brand (integer)name.{nl|fr|...}
: Name of the brand (string, localized)meta
:createdAt
: When the brand was created on Medipim (unix timestamp)updatedAt
: when the brand information was last updated (unix timestamp)
organizations[]
: A collection of organizations associated with this product. | POST /v4/organizations/query responseid
: ID of the organization (integer, unique)name.{nl|fr|...}
: Name of the organization (string, localized)type
: type of the organization (supplier
ormarketing
)meta
createdAt
: When the organization information was created on Medipim (unix timestamp)updatedAt
: When the organization information was last updated (unix timestamp) <!-- *attributes[]
: A collection of attributes associated with this product. | GET /v3/attributes/all response
id
: ID of the attribute (integer, unique)name.{nl|fr|en}
: Name of the attribute (string, localized)meta
:createdAt
: When the attribute information was created on Medipim (unix timestamp)updatedAt
: When the attribute information was last updated (unix timestamp) -->
activeIngredients[]
: A collection of active ingredients associated with this product | GET /v4/active-ingredients/query responseid
: ID of the active ingredient (integer, unique)name.{nl|fr|...}
: Name of the active ingredient (string, localized)meta
:createdAt
: When the active ingredient was created on Medipim (unix timestamp)updatedAt
: When the active ingredients was last updated (unix timestamp)
photos[]
: A collection of photos associated with this product. (same as media query results)frontals[]
: A collection of frontal photos associated with this product. (same as media query results)links[]
: A collection of media links associated with this product. (same as media query results)descriptions[]
: A collection of descriptions for this product.id
: ID of the description. (integer, unique)locales[]
: Languages for which this description is suitable. (string[])targetGroups[]
: Target groups for which this description is suitable. (string[])type
: Type of description. (string)content.{nl|fr|...}
: Description content (string, localized)meta
:createdAt
: When the description was created on Medipim (unix timestamp)updatedAt
: When the description was last updated (unix timestamp)
leaflets[]
: A collection of leaflets for this product.id
: ID of the leaflet (integer, unique)locales[]
: Languages for which the leaflet is suitable.type
: Type of leaflet (pil
orspc
)url.{nl|fr|...}
: Urls of the leaflet (string, localized)meta
:createdAt
: When the leaflet was added on Medipim (unix timestamp)updatedAt
: When the leaflet was last updated (unix timestamp)
meta
: Product metadatacreatedAt
: When the product was added to Medipim. (unix timestamp)updatedAt
: The last time the product was modified (includes modifications to photos, links, ...). (unix timestamp)embedUrl
: A pre-signed link to the embed endpoint for this product. Note that this URL is only valid a few hours. (string)
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