Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Product

Get product

get/products/{id}

Path parameters

idstring int64 required

Query parameters

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

ValueFormat
archived_atdate-time

Response

Successful operation

archived_atstring date-time nullable
cost_pricestring decimal nullable
created_atstring date-time
idstring int64
item_codestring nullable
namestring
notesstring nullable
price_ex_taxstring decimal nullable
price_including_taxstring decimal nullable
serial_numberstring nullable
stock_levelstring decimal nullable
updated_atstring date-time
product_supplier_idstring int64

Example response

{
  "links": {
    "self": "https://api.au1.cliniko.com/v1/products/1"
  },
  "product_supplier": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/product_suppliers/1"
    }
  },
  "stock_adjustments": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/stock_adjustments?q%5B%5D=product_id%3A%3D1"
    }
  },
  "tax": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/taxes/1"
    }
  }
}