Medipim BE - API V4

Developer documentation

POST /v4/product-families/query

(Last updated: 20/12/2024)

Request

Method

POST

URL

https://api.medipim.be/v4/product-families/query

Headers

Body

  • filter: one of the filters below; filters can be combined using and, or & not. (optional)
  • sorting: one of the sortings below. (optional; default is {"id": "ASC"})
  • page (optional; if none is provided all results are returned)
    • no: page number (zero-based)
    • size: one of 10, 50, 100 or 250 (defaults to 100)
Filter Description Parameters Examples
{"id": ...} Matches product families by Medipim ID. One or more IDs {"id": 1} or {"id": [1, 2]}
{"search": ...} Matches product families by a specific search query. String {"search": "somesearchterm"}
{"and": [...]} Matches product families that match all of the given filters. A list of filters. {"and": [{"id": 1}, {"search": "test"}]}
{"or": [...]} Matches product families that match any of the given filters. A list of filters. {"or": [{"id": 1}, {"search": "test"}]}
{"not": ...} Matches product families that do not match the given filter. A filter. {"not": {"id": 1}}
Sorting Description Parameters Examples
{"id": ...} Sort by Medipim ID "ASC" or "DESC" {"id": "ASC"} or {"id": "DESC"}
{"name": ...} Sort by Name "ASC" or "DESC" {"name": "ASC"} or {"name": "DESC"}

Response

Body

  • meta:
    • total: total number of product families (integer)
    • page:
      • no: page number (zero-based) (integer)
      • offset: offset of the first item in the entire resultset (integer)
      • size: size of the page (integer)
  • results[]:
    • id: Medipim ID of the product family (integer)
    • name.{...}: Name of the product family (string)
    • meta:
      • createdAt: When the product family was created on Medipim (unix timestamp)
      • updatedAt: when the product family information was last updated (unix timestamp)

Notice

The meta page section will only be returned if you added a page in the request body.

Examples