Price Sheet Item Collection

Description

A collection of Price Sheet Items

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
bleedWrap

Decimal value representing the bounds of the item that are wrapped around the item and not visible from the front.

bounds

The dimensional bounds of the price sheet item.

chargeShipping

Denotes if the price sheet item should be included when calculating shipping charges.

created

The creation date of this price sheet item.

description

A description to display to the user in order to give them more information about the item.

displayOrder

The order in which the item should be displayed in a list of items.

hasDownload

Denotes that the item includes a free digital download of the image used for the item.

hideBleedWrap

Denotes that bleed wrap should not be displayed when showing the item.

id

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

imageCount

Count of the number of images associated with the price sheet item.

images

An array of images that shows the item.

isTaxExempt

Denotes that the item price should not be included when calculating sales taxes.

labCatalogProductId nullable

If the item is lab fulfilled, the ID of the lab catalog product which was used to create the item.

labCost

Decimal value of the lab cost the studio pays to order the item.

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 item.

price

Decimal value of the price to be charged for the item.

priceSheetGroupId

The identifier of the Price Sheet Group which contains the Item. Required when creating a new Price Sheet Item.

priceSheetSubgroupId nullable

The identifier of the Price Sheet Subgroup which contains the Item. Cannot be changed after the item has been created.

shippingCharge nullable

Decimal value of any additional charge for shipping the item, in addition to any shipping for the order.

size

The dimenstions of the item.

These values are not used when update creating or updating a Lab-fulfilled Price Sheet Item.

Property Description
depth nullable

The depth of the item.

height nullable

The height of the item.

width nullable

The width of the item.

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 Items",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A product item within the price sheet which a user can choose to order.",
        "properties": {
          "bleedWrap": {
            "description": "Decimal value representing the bounds of the item that are wrapped\naround the item and not visible from the front.",
            "type": "number"
          },
          "bounds": {
            "description": "The dimensional bounds of the price sheet item.",
            "type": "string"
          },
          "chargeShipping": {
            "description": "Denotes if the price sheet item should be included when calculating\nshipping charges.",
            "type": "boolean"
          },
          "created": {
            "description": "The creation date of this price sheet item.",
            "format": "date-time",
            "type": "string"
          },
          "description": {
            "description": "A description to display to the user in order to give them more\ninformation about the item.",
            "type": "string"
          },
          "displayOrder": {
            "description": "The order in which the item should be displayed in a list of items.",
            "type": "integer"
          },
          "hasDownload": {
            "description": "Denotes that the item includes a free digital download of the image\nused for the item.",
            "type": "boolean"
          },
          "hideBleedWrap": {
            "description": "Denotes that bleed wrap should not be displayed when showing the\nitem.",
            "type": "boolean"
          },
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "imageCount": {
            "description": "Count of the number of images associated with the price sheet item.",
            "type": "integer"
          },
          "images": {
            "description": "An array of images that shows the item.",
            "items": {
              "$ref": "#/components/schemas/PriceSheetElementImage"
            },
            "title": "Price Sheet Element Image",
            "type": "array"
          },
          "isTaxExempt": {
            "description": "Denotes that the item price should not be included when calculating\nsales taxes.",
            "type": "boolean"
          },
          "labCatalogProductId": {
            "description": "If the item is lab fulfilled, the ID of the lab catalog product\nwhich was used to create the item.",
            "nullable": true,
            "type": "integer"
          },
          "labCost": {
            "description": "Decimal value of the lab cost the studio pays to order the item.",
            "type": "number"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The name of the price sheet item.",
            "type": "string"
          },
          "price": {
            "description": "Decimal value of the price to be charged for the item.",
            "type": "number"
          },
          "priceSheetGroupId": {
            "allOf": [
              {
                "description": "The identifier of the Price Sheet Group which contains the Item.\nRequired when creating a new Price Sheet Item."
              },
              {
                "$ref": "#/components/schemas/Id"
              }
            ]
          },
          "priceSheetSubgroupId": {
            "allOf": [
              {
                "description": "The identifier of the Price Sheet Subgroup which contains the Item.\nCannot be changed after the item has been created."
              },
              {
                "nullable": true
              },
              {
                "$ref": "#/components/schemas/Id"
              }
            ]
          },
          "shippingCharge": {
            "description": "Decimal value of any additional charge for shipping the item, in\naddition to any shipping for the order.",
            "nullable": true,
            "type": "number"
          },
          "size": {
            "description": "The dimenstions of the item.\n\nThese values are not used when update creating or updating a Lab-fulfilled\nPrice Sheet Item.",
            "properties": {
              "depth": {
                "description": "The depth of the item.",
                "nullable": true,
                "type": "number"
              },
              "height": {
                "description": "The height of the item.",
                "nullable": true,
                "type": "number"
              },
              "width": {
                "description": "The width of the item.",
                "nullable": true,
                "type": "number"
              }
            },
            "type": "object"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "price-sheet-item"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "name",
          "displayOrder",
          "price",
          "priceSheetGroupId"
        ],
        "title": "Price Sheet Item",
        "type": "object"
      },
      "title": "Price Sheet Item",
      "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-item-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}