latestOpenAPI 3.0.0Apache 2.02026-08-201250995.7 KB

bd9694db5fce

Product

List all Products

Permissions needed: NONE Search for products in the clinic

get/api/v1/products

Query parameters

filter[search]string

Searching by product name

filter[service_package_id]integer

filter[categories]integer[]

Categories Ids

filter[producer_ids]integer[]

filter[aaha_codes]string[]

filter[status]'active' | 'inactive' | 'both'

Status: active, inactive

filter[only_in_stock]boolean

filter[mapped_to_external_products]boolean

Return only products that are mapped (true) or not mapped (false) to external products. If omitted, all products will be returned.

filter[external_product_provider]'cdmv' | 'midwest' | 'nsv'

Should be used in conjuction with filter[mapped_to_external_products] to indicate to external products of which provider returned product should be or not be mapped to

filter[exclude_newly_auto_created]boolean

filter[subset]string

Only products in specified category group (supports: 'vaccination')

filter[is_consumable]boolean

filter[vat]number

VAT rate in percents (e.g. 23)

sortstring[]

Order by field(s) (name,aaha_code,vat) Use a minus before for descending order. Default: name

includestring

Additional info to include: productCategory,stock,nirProducts,nirProducts.nirStocks,aahaCategory,producer,taskTemplates,externalProducts,taxRates

Parameters

#/paths/~1api~1v1~1pets/get/parameters/0 — unresolved $ref

Response

Successful operation

dataData[] — unresolved $ref

linksLinks — unresolved $ref

metaMeta — unresolved $ref