Price Sheet Add On Group

Description

An object containing a collection of add-on options which can be added to a price sheet item.

Properties

Property Description
addOnOptions

The collection of add-on options which are part of the group.

created

The creation date of this price sheet add-on group.

description

A description to display to the user in order to give them more information about the add-on group

displayOrder

The order in which the add-on group should be displayed in a list of add-on groups for an item.

id

The identifier for the price sheet add-on group.

image required

An image that shows a representation of the add-on group.

isRequiredAddOn

Denotes that the add-on group is required, meaning that one of the add-on options from the group must be selected when purchasing the item.

labCatalogAddOnGroupId nullable

If the add-on group is lab fulfilled, the ID of the lab catalog add-on group which was used to create the add-on group

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 price sheet add-on group.

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": "An object containing a collection of add-on options which can be added\nto a price sheet item.",
  "properties": {
    "addOnOptions": {
      "description": "The collection of add-on options which are part of the group.",
      "items": {
        "$ref": "#/components/schemas/PriceSheetAddOnOption"
      },
      "title": "Price Sheet Add-on Option",
      "type": "array"
    },
    "created": {
      "description": "The creation date of this price sheet add-on group.",
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "description": "A description to display to the user in order to give them more\ninformation about the add-on group",
      "type": "string"
    },
    "displayOrder": {
      "description": "The order in which the add-on group should be displayed in a list of\nadd-on groups for an item.",
      "type": "integer"
    },
    "id": {
      "description": "The identifier for the price sheet add-on group.",
      "type": "integer"
    },
    "image": {
      "allOf": [
        {
          "description": "An image that shows a representation of the add-on group."
        },
        {
          "$ref": "#/components/schemas/PriceSheetElementImage"
        }
      ]
    },
    "isRequiredAddOn": {
      "description": "Denotes that the add-on group is required, meaning that one of the\nadd-on options from the group must be selected when purchasing the\nitem.",
      "type": "boolean"
    },
    "labCatalogAddOnGroupId": {
      "description": "If the add-on group is lab fulfilled, the ID of the lab catalog\nadd-on group which was used to create the add-on group",
      "nullable": true,
      "type": "integer"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the price sheet add-on group.",
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "price-sheet-add-on-group"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "name",
    "displayOrder"
  ],
  "title": "Price Sheet Add-on Group",
  "type": "object"
}