Price Sheet Collection

Description

A collection of price sheets with minimal data.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
created

The creation date of this price sheet.

discountsCount

The total number of discounts associated with the price sheet.

fulfillmentLabId

The id of the lab used to fulfill items purchased from the price sheet.

id

The identifier for this price sheet.

itemsCount

The total number of items the price sheet contains.

labCatalogId nullable

The ID of the lab catalog which the price sheet is based on

linkedCartsCount read-only

The total number of carts containing items in the price sheet.

linkedEventsCount read-only

The total number of non-deleted events that are using the price sheet.

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

Human readable name for this price sheet.

type

The type of object 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 model type for the list response object.

OpenAPI Schema

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

{
  "description": "A collection of price sheets with minimal data.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A price sheet as viewed from a collection.",
        "properties": {
          "created": {
            "description": "The creation date of this price sheet.",
            "format": "date-time",
            "type": "string"
          },
          "discountsCount": {
            "description": "The total number of discounts associated with the price sheet.",
            "type": "integer"
          },
          "fulfillmentLabId": {
            "description": "The id of the lab used to fulfill items purchased from the price\nsheet.",
            "type": "string"
          },
          "id": {
            "description": "The identifier for this price sheet.",
            "type": "integer"
          },
          "itemsCount": {
            "description": "The total number of items the price sheet contains.",
            "type": "integer"
          },
          "labCatalogId": {
            "description": "The ID of the lab catalog which the price sheet is based on",
            "nullable": true,
            "type": "integer"
          },
          "linkedCartsCount": {
            "description": "The total number of carts containing items in the price sheet.",
            "readOnly": true,
            "type": "integer"
          },
          "linkedEventsCount": {
            "description": "The total number of non-deleted events that are using the price\nsheet.",
            "readOnly": true,
            "type": "integer"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "Human readable name for this price sheet.",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "price-sheet"
            ],
            "type": "string"
          }
        },
        "title": "Price Sheet",
        "type": "object"
      },
      "title": "Price Sheet",
      "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 model type for the list response object.",
      "enum": [
        "price-sheet-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}