A product offered by the lab.
Property | Description |
---|---|
alternateDisplayName nullable |
An alternate name for the product. |
bounds |
A comma delimited list that specifies the product bounds. |
boundsName nullable |
The name given to the bounds description for the product. |
description nullable |
Display text shown to the user in order to give them information concerning the product. |
id |
The identifier for the lab catalog product. |
isBestseller |
Denotes if the item is a best seller, meaning that the product should appear in a new price sheet that is created with the 'Best Seller' option selected. |
labCatalogGroupId nullable |
An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string. |
links required read-only |
Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name. |
name |
The name of the lab catalog product. |
productSize nullable |
The size of the product in human readable terms. |
retailPrice |
A decimal value of the retail price of the product. |
type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A product offered by the lab.",
"properties": {
"alternateDisplayName": {
"description": "An alternate name for the product.",
"nullable": true,
"type": "string"
},
"bounds": {
"description": "A comma delimited list that specifies the product bounds.",
"type": "string"
},
"boundsName": {
"description": "The name given to the bounds description for the product.",
"nullable": true,
"type": "string"
},
"description": {
"description": "Display text shown to the user in order to give them information\nconcerning the product.",
"nullable": true,
"type": "string"
},
"id": {
"description": "The identifier for the lab catalog product.",
"type": "integer"
},
"isBestseller": {
"description": "Denotes if the item is a best seller, meaning that the product\nshould appear in a new price sheet that is created with the 'Best\nSeller' option selected.",
"type": "boolean"
},
"labCatalogGroupId": {
"allOf": [
{
"nullable": true
},
{
"$ref": "#/components/schemas/Id"
}
]
},
"links": {
"$ref": "#/components/schemas/Links"
},
"name": {
"description": "The name of the lab catalog product.",
"type": "string"
},
"productSize": {
"description": "The size of the product in human readable terms.",
"nullable": true,
"type": "string"
},
"retailPrice": {
"description": "A decimal value of the retail price of the product.",
"type": "number"
},
"type": {
"allOf": [
{
"enum": [
"lab-catalog-product"
]
},
{
"$ref": "#/components/schemas/Type"
}
]
}
},
"title": "Lab Catalog Product",
"type": "object"
}