Price Sheet Item

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "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.",
      "readOnly": true,
      "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.",
      "maxLength": 250,
      "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 dimensions 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.",
          "maximum": 1000,
          "minimum": 0,
          "nullable": true,
          "type": "number"
        },
        "height": {
          "description": "The height of the item.",
          "maximum": 1000,
          "minimum": 0,
          "nullable": true,
          "type": "number"
        },
        "width": {
          "description": "The width of the item.",
          "maximum": 1000,
          "minimum": 0,
          "nullable": true,
          "type": "number"
        }
      },
      "type": "object"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "price-sheet-item"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "displayOrder",
    "price",
    "priceSheetGroupId"
  ],
  "title": "Price Sheet Item",
  "type": "object"
}