Price Sheet Item Digital

Description

A product item within the price sheet which a user can choose to order.

Properties

Property Description
allAlbumPhotosDownload

Information that applied to a ShootProof-Fulfilled digital download of all photos in an album.

Property Description
isDigitalDownloadForSale nullable

Denotes that the digital download item should be available to be purchased.

price nullable

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

allGalleryPhotosDownload

Information that applied to a ShootProof-Fulfilled digital download of all photos in gallery.

Property Description
isDigitalDownloadForSale nullable

Denotes that the digital download item should be available to be purchased.

price nullable

Decimal value of the price to be charged for the 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.

digitalDownloadType nullable

Denotes that the item is a ShootProof-Fulfilled digital download. Can only be set when first creating a Digital Download Item.

displayOrder

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

id

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

individualPhotoDownload

Information that applied to a ShootProof-Fulfilled digital download of a single, individual photo.

Property Description
isDigitalDownloadForSale nullable

Denotes that the digital download item should be available to be purchased.

price nullable

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

isDigitalDownload

Denotes that the item is a ShootProof-Fulfilled digital download.

isTaxExempt

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

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.

pixels nullable

The pixel count of the longest side for each image that will be included in the digital download.

price nullable

Decimal value of the price to be charged for the item. If the digital item is a ShootProof-Fulfilled Digital Download, then this value should be null.

shippingCharge nullable

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

status

The current status of the price sheet item.

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 product item within the price sheet which a user can choose to order.",
  "properties": {
    "allAlbumPhotosDownload": {
      "description": "Information that applied to a ShootProof-Fulfilled digital download of all\nphotos in an album.",
      "properties": {
        "isDigitalDownloadForSale": {
          "description": "Denotes that the digital download item should be available to be\npurchased.",
          "nullable": true,
          "type": "boolean"
        },
        "price": {
          "description": "Decimal value of the price to be charged for the item.",
          "nullable": true,
          "type": "number"
        }
      },
      "type": "object"
    },
    "allGalleryPhotosDownload": {
      "description": "Information that applied to a ShootProof-Fulfilled digital download of all\nphotos in gallery.",
      "properties": {
        "isDigitalDownloadForSale": {
          "description": "Denotes that the digital download item should be available to be\npurchased.",
          "nullable": true,
          "type": "boolean"
        },
        "price": {
          "description": "Decimal value of the price to be charged for the item.",
          "nullable": true,
          "type": "number"
        }
      },
      "type": "object"
    },
    "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"
    },
    "digitalDownloadType": {
      "description": "Denotes that the item is a ShootProof-Fulfilled digital download. Can only\nbe set when first creating a Digital Download Item.",
      "enum": [
        "full-resolution",
        "high-resolution",
        "medium-resolution",
        "low-resultion",
        "custom"
      ],
      "nullable": true,
      "type": "string"
    },
    "displayOrder": {
      "description": "The order in which the item should be displayed in a list of items.",
      "type": "integer"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "individualPhotoDownload": {
      "description": "Information that applied to a ShootProof-Fulfilled digital download of a\nsingle, individual photo.",
      "properties": {
        "isDigitalDownloadForSale": {
          "description": "Denotes that the digital download item should be available to be\npurchased.",
          "nullable": true,
          "type": "boolean"
        },
        "price": {
          "description": "Decimal value of the price to be charged for the item.",
          "nullable": true,
          "type": "number"
        }
      },
      "type": "object"
    },
    "isDigitalDownload": {
      "description": "Denotes that the item is a ShootProof-Fulfilled digital download.",
      "type": "boolean"
    },
    "isTaxExempt": {
      "description": "Denotes that the item price should not be included when calculating\nsales taxes.",
      "type": "boolean"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the price sheet item.",
      "type": "string"
    },
    "pixels": {
      "description": "The pixel count of the longest side for each image that will be included\nin the digital download.",
      "nullable": true,
      "type": "number"
    },
    "price": {
      "description": "Decimal value of the price to be charged for the item. If the digital item\nis a ShootProof-Fulfilled Digital Download, then this value should be null.",
      "nullable": true,
      "type": "number"
    },
    "shippingCharge": {
      "description": "Decimal value of any additional charge for shipping the item, in\naddition to any shipping for the order.",
      "nullable": true,
      "type": "number"
    },
    "status": {
      "description": "The current status of the price sheet item.",
      "enum": [
        "active",
        "deleted"
      ],
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "price-sheet-item-digital"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "displayOrder"
  ],
  "title": "Price Sheet Digital Item",
  "type": "object"
}