Search products

1 min

GET

/api/v1/products

Search products

Query Parameters

filter[search]string
Description
Searching by product name
filter[service_package_id]integer
filter[categories]integer[]
Description
Categories Ids
filter[producer_ids]integer[]
filter[aaha_codes]string[]
filter[status]string
Description
Status: active, inactive
Default
active
filter[only_in_stock]boolean
Default
false
filter[subset]string
Description
Only products in specified category group (supports: 'vaccination')
sortstring[]
Description
Order by field(s) (name,aaha_code,vat) Use a minus before for descending order. Default: name
includestring
Description
Additional info to include: productCategory,stock,nirProducts,aahaCategory,producer

Responses

200Successful operation

object
- dataobject[]
  - idinteger
    Example
    670
  - namestring
    Example
    Product Prof. Peter Dach
  - unitstring
    Example
    package
  - unitsobject
    - 0string
      Example
      tablets
    - 1string
      Example
      package
  - sub_unitstring
    Example
    tablets
  - recommended_unit_pricestring
    Example
    11.853
  - recommended_subunit_pricenumber
    Example
    1.6932857142857143
  - formulainteger
    Example
    7
  - active_substancesstring
  - administrationstring
  - recommendationsstring
  - fixed_feestring
    Example
    0.000
  - barcodestring
    Example
    99425161
  - producer_idstring
    Example
    670
  - clinic_idstring
    Example
    3876
  - vatinteger
  - is_controlledboolean
  - statusboolean
    Example
    true
- linkslinks
- metameta

400

curl

curl --request GET \
     --url '/api/v1/products?filter[status]=active&filter[only_in_stock]=false' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/api/v1/products?filter[status]=active&filter[only_in_stock]=false", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/api/v1/products?filter[status]=active&filter[only_in_stock]=false")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/api/v1/products?filter[status]=active&filter[only_in_stock]=false"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful operation
{
  "data": [
    {
      "id": 670,
      "name": "Product Prof. Peter Dach",
      "unit": "package",
      "units": {
        "0": "tablets",
        "1": "package"
      },
      "sub_unit": "tablets",
      "recommended_unit_price": "11.853",
      "recommended_subunit_price": 1.6932857142857143,
      "formula": 7,
      "active_substances": "",
      "administration": "",
      "recommendations": "",
      "fixed_fee": "0.000",
      "barcode": "99425161",
      "producer_id": "670",
      "clinic_id": "3876",
      "vat": 0,
      "is_controlled": false,
      "status": true
    }
  ],
  "links": {},
  "meta": {}
}

400