Price Sheet Group Collection

Description

A collection of Price Sheet Groups

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
created read-only

The creation date of this price sheet group.

description

Display text shown to the user in order to give them information concerning the group and the type of items which it may contain.

displayOrder

The order in which the group should be displayed in a list of groups for a price sheet

groupType read-only

The slug name of the type of price sheet item group.

id read-only

The identifier for the price sheet group.

images

An array of images which display the types of items which may be contained within the group.

isDefault read-only

Denotes if the group is a default group.

isFeaturedType

Denotes that the group is meant to contain items which are to be featured in the price sheet.

isPackageType

Denotes that the group is meant to contain packages.

labCatalogGroupId

The ID of the lab catalog group which was used to create the 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 group.

priceSheetItems

An array containing the items which are part of the group.

priceSheetSubgroups

An array containing the various subgroups of items within the group.

status read-only

The current status of the price sheet group.

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 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 collection of Price Sheet Groups",
  "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.",
        "properties": {
          "created": {
            "description": "The creation date of this price sheet group.",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
          },
          "description": {
            "description": "Display text shown to the user in order to give them information\nconcerning the group and the type of items which it may contain.",
            "type": "string"
          },
          "displayOrder": {
            "description": "The order in which the group should be displayed in a list of groups\nfor a price sheet",
            "type": "integer"
          },
          "groupType": {
            "description": "The slug name of the type of price sheet item group.",
            "enum": [
              "custom",
              "prints",
              "canvas",
              "digitals",
              "products",
              "metals",
              "fine-art"
            ],
            "readOnly": true,
            "type": "string"
          },
          "id": {
            "description": "The identifier for the price sheet group.",
            "readOnly": true,
            "type": "integer"
          },
          "images": {
            "description": "An array of images which display the types of items which may be\ncontained within the group.",
            "items": {
              "$ref": "#/components/schemas/PriceSheetElementImage"
            },
            "type": "array"
          },
          "isDefault": {
            "description": "Denotes if the group is a default group.",
            "readOnly": true,
            "type": "boolean"
          },
          "isFeaturedType": {
            "description": "Denotes that the group is meant to contain items which are to be\nfeatured in the price sheet.",
            "type": "boolean"
          },
          "isPackageType": {
            "description": "Denotes that the group is meant to contain packages.",
            "type": "boolean"
          },
          "labCatalogGroupId": {
            "description": "The ID of the lab catalog group which was used to create the group.",
            "type": "integer"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The name of the price sheet group.",
            "type": "string"
          },
          "priceSheetItems": {
            "description": "An array containing the items which are part of the group.",
            "items": {
              "oneOf": [
                {
                  "$ref": "#/components/schemas/PriceSheetItem"
                },
                {
                  "$ref": "#/components/schemas/PriceSheetItemDigital"
                }
              ]
            },
            "title": "Price Sheet Item",
            "type": "array"
          },
          "priceSheetSubgroups": {
            "description": "An array containing the various subgroups of items within the group.",
            "items": {
              "$ref": "#/components/schemas/PriceSheetSubgroup"
            },
            "type": "array"
          },
          "status": {
            "description": "The current status of the price sheet group.",
            "enum": [
              "active",
              "deleted"
            ],
            "readOnly": true,
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "price-sheet-group"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "name",
          "displayOrder"
        ],
        "title": "Price Sheet Group",
        "type": "object"
      },
      "title": "Price Sheet Group",
      "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-group-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}