Price Sheet Subgroup

Description

A container for a collection of related items within the price sheet, subordinate to a Price Sheet Group.

Properties

Property Description
bounds nullable read-only

The dimensional bounds of the price sheet subgroup.

displayOrder

The order in which the subgroup should be displayed in a list of subgroups for a price sheet or price sheet group.

id

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

isCatchall deprecated

Denotes that the subgroup contains items that are not intended to belong in a subgroup based by size or commonality. This property is only set when creating a new subgroup.

isCustom read-only

Denotes if the Subgroup was created by the Studio.

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 nullable

The name of the price sheet subgroup.

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 container for a collection of related items within the price sheet, subordinate to a Price Sheet Group.",
  "properties": {
    "bounds": {
      "description": "The dimensional bounds of the price sheet subgroup.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "displayOrder": {
      "description": "The order in which the subgroup should be displayed in a list of subgroups\nfor a price sheet or price sheet group.",
      "type": "integer"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "isCatchall": {
      "deprecated": true,
      "description": "Denotes that the subgroup contains items that are not intended to belong\nin a subgroup based by size or commonality. This property is only set when\ncreating a new subgroup.",
      "type": "boolean"
    },
    "isCustom": {
      "description": "Denotes if the Subgroup was created by the Studio.",
      "readOnly": true,
      "type": "boolean"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the price sheet subgroup.",
      "nullable": true,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "enum": [
            "price-sheet-subgroup"
          ]
        },
        {
          "$ref": "#/components/schemas/Type"
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "displayOrder"
  ],
  "title": "Price Sheet Subgroup",
  "type": "object"
}