A collection of Price Sheet Subgroups
Property | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items |
A collection of resources returned in the current result set.
|
||||||||||||||||||
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.
|
||||||||||||||||||
type |
The type of resource represented. |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"description": "A collection of Price Sheet Subgroups",
"properties": {
"items": {
"description": "A collection of resources returned in the current result set.",
"items": {
"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"
},
"title": "Price Sheet Subgroup",
"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": [
"price-sheet-subgroup-collection"
],
"example": "resource-type",
"title": "Resource Type",
"type": "string"
}
},
"required": [
"type",
"items"
],
"title": "Collection",
"type": "object"
}