Lab Catalog Product Collection

Description

A collection (or list) of resources.

Properties

Property Description
items

A collection of resources returned in the current result set.

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.

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.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "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"
      },
      "title": "Lab Catalog Product",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "lab-catalog-product-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Lab Catalog Product Collection",
  "type": "object"
}