Price Sheet In List

Description

A price sheet as viewed from a collection.

Properties

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.

linkedEventDefaultsCount read-only

The total number of Brand Events Defaults using this 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.

packageCount read-only

The total number of packages in the price sheet.

type

The type of object represented.

OpenAPI Schema

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

{
  "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"
    },
    "linkedEventDefaultsCount": {
      "description": "The total number of Brand Events Defaults using this 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"
    },
    "packageCount": {
      "description": "The total number of packages in the price sheet.",
      "readOnly": true,
      "type": "integer"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "price-sheet"
      ],
      "type": "string"
    }
  },
  "title": "Price Sheet",
  "type": "object"
}