Skip to main content

Query product families

POST 
/product-families/query

Search and filter product families. A product family groups related products together — for example, different strengths or pack sizes of the same medicine.

Filter​

The optional filter object supports the following filters:

  • id — match by product family ID (integer or array of integers).
  • search — full-text search on the family name (string).
  • and — match all of the given filters.
  • or — match any of the given filters.
  • not — negate a filter.

Sorting​

The optional sorting object accepts a single sortable field:

  • id — sort by product family ID (default).
  • name — sort by name.

The value is the sort direction: asc or desc.

Pagination​

Use the page object to paginate results. If omitted, all results are returned.

Request​

Responses​

Successful operation