Products
A product is a test that you can order from London Medical Laboratory to use in the Order or Test Registration call.
The Products model
The Product model contains all the information about the Product.
Properties
- Name
id
- Type
- string
- Description
Unique identifier for the Product.
- Name
name
- Type
- string
- Description
Product Name.
- Name
sku
- Type
- string
- Description
Unique Product SKU, can be used in Test Registration calls instead of ID.
- Name
preview_image_url
- Type
- url
- Description
Small thumbnail of product packaging.
- Name
price
- Type
- object
- Description
Product recommended RRP.
- Name
slug
- Type
- string
- Description
Product name as a slug.
- Name
description
- Type
- string
- Description
Product description as HTML string.
- Name
short_description
- Type
- string
- Description
Product short description as HTML string.
Get All Products
This endpoint allows you to get all available products. Suggest storing these in a database your side.
By default this will return saleable boxed products. To retrieve all products that can be performed at
a test location pass through a parameter ?all_products=1
Attributes
Returns
Returns a paginated list of Product objects if successful.
Request
curl -G https://api.londonmedicallaboratory.com/api/product/ \
-H "Authorization: Bearer {token}"
Response
{
"nr_of_results": 32,
"current_page": 1,
"nr_of_pages": 1,
"results_per_page": 100,
"next_page": null,
"items": [
{
"id": "73d1f6c9-dd60-4f78-bc10-7898d9c66d80",
"name": "Allergy Complete - 295 allergens",
"sku": "AL2",
"preview_image_url": null,
"price": {
"amount_minor": 100,
"currency": "GBP",
"formatted_value": "£1.00"
},
"slug": "allergy-complete-295-allergens",
"description": "Allergy Complete - 295 allergens",
"short_description": "Allergy Complete - 295 allergens"
},
{
"id": "31e970c1-b59c-47a3-bbb2-227bafcb6379",
"name": "Anaemia Profile",
"sku": "ANE",
"preview_image_url": null,
"price": {
"amount_minor": 100,
"currency": "GBP",
"formatted_value": "£1.00"
},
"slug": "anaemia-profile",
"description": "Anaemia Profile",
"short_description": "Anaemia Profile"
},
{
"id": "f815c0af-c8d7-4ed8-b362-b2c01d73e9cc",
"name": "C19 - Covid PCR Same Day",
"sku": "C19",
"preview_image_url": null,
"price": {
"amount_minor": 100,
"currency": "GBP",
"formatted_value": "£1.00"
},
"slug": "c19-covid-pcr-same-day",
"description": "Covid same day",
"short_description": "Covid same day"
}
]
}