Price Sheet Add On Option : Studio API : Reference : ShootProof for Developers

Description

price-sheet-add-on-option

Price Sheet Add-on Option

An item which can be added to an item when purchased.

Properties

Property	Description
created	`string` date-time The creation date of this price sheet add-on option.
description	`string` A description to display to the user in order to give them more information about the add-on option.
displayOrder	`integer` The order in which the add-on option should be displayed in a list of add-on option with a group.
id	`integer` The identifier for the price sheet add-on option.
images	`price-sheet-element-image[]` Price Sheet Element Image An array of images that shows the add-on option.
isTaxExempt	`boolean` Denotes that the price of the add-on option should not be included when calculating sales taxes.
labCatalogAddOnOptionId nullable	`integer` If the add-on option is lab fulfilled, the ID of the lab catalog add-on option which was used to create the add-on option
links required read-only	`object` Links 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	`string` The name of the price sheet add-on option.
price	`number` Decimal value of the price to be charged for the add-on option.
shippingCharge nullable	`number` Decimal value of any additional charge for shipping the add-on option, in addition to any shipping for the order.
type	`string` enum price-sheet-add-on-option The type of object represented.

OpenAPI Schema

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

{
  "description": "An item which can be added to an item when purchased.",
  "properties": {
    "created": {
      "description": "The creation date of this price sheet add-on option.",
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "description": "A description to display to the user in order to give them more\ninformation about the add-on option.",
      "type": "string"
    },
    "displayOrder": {
      "description": "The order in which the add-on option should be displayed in a list\nof add-on option with a group.",
      "type": "integer"
    },
    "id": {
      "description": "The identifier for the price sheet add-on option.",
      "type": "integer"
    },
    "images": {
      "description": "An array of images that shows the add-on option.",
      "items": {
        "$ref": "#/components/schemas/PriceSheetElementImage"
      },
      "type": "array"
    },
    "isTaxExempt": {
      "description": "Denotes that the price of the add-on option should not be included\nwhen calculating sales taxes.",
      "type": "boolean"
    },
    "labCatalogAddOnOptionId": {
      "description": "If the add-on option is lab fulfilled, the ID of the lab catalog\nadd-on option which was used to create the add-on option",
      "nullable": true,
      "type": "integer"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the price sheet add-on option.",
      "type": "string"
    },
    "price": {
      "description": "Decimal value of the price to be charged for the add-on option.",
      "type": "number"
    },
    "shippingCharge": {
      "description": "Decimal value of any additional charge for shipping the add-on\noption, in addition to any shipping for the order.",
      "nullable": true,
      "type": "number"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "price-sheet-add-on-option"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "name",
    "displayOrder"
  ],
  "title": "Price Sheet Add-on Option",
  "type": "object"
}

Price Sheet Add-on Option