Price Sheet

OpenAPI Schema

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

{
  "description": "An object containing the settings and configurations of the price sheet\nto be used by a studio to determine the pricing of products.",
  "properties": {
    "allowLabShippingSpeedSelection": {
      "description": "Determines if the client should be allowed to select a shipping\nspeed offered by the lab during checkout",
      "type": "boolean"
    },
    "created": {
      "description": "The creation date of this price sheet.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "createdFromBestsellers": {
      "description": "Denotes if the price sheet was originally created with auto-populate\nitems from the lab catalog's best seller's list.",
      "type": "boolean"
    },
    "id": {
      "description": "The identifier for the price sheet.",
      "readOnly": true,
      "type": "integer"
    },
    "labCatalogId": {
      "description": "The ID of the lab catalog which the price sheet is based on",
      "nullable": true,
      "type": "integer"
    },
    "linkedCartsCount": {
      "description": "The total number of carts containing items in the price sheet.",
      "readOnly": true,
      "type": "integer"
    },
    "linkedEventDefaultsCount": {
      "description": "The total number of events defaults using this price sheet.",
      "readOnly": true,
      "type": "integer"
    },
    "linkedEventsCount": {
      "description": "The total number of non-deleted events that are using the price\nsheet.",
      "readOnly": true,
      "type": "integer"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the price sheet.",
      "type": "string"
    },
    "packageCount": {
      "description": "The total number of packages in the price sheet.",
      "readOnly": true,
      "type": "integer"
    },
    "priceSheetGroups": {
      "description": "An array of group of items that are contained by the price sheet.",
      "items": {
        "$ref": "#/components/schemas/PriceSheetGroup"
      },
      "type": "array"
    },
    "retouch": {
      "description": "Setting for Retouch add-on, an optional add-on that is applied\nacross all items of the price sheet.",
      "nullable": true,
      "properties": {
        "description": {
          "description": "Text to describe the retouch add-on to customers.",
          "type": "string"
        },
        "label": {
          "description": "Label of the retouch add-on as it will be displayed to the user.",
          "type": "string"
        },
        "position": {
          "description": "Denotes if the retouch add-on should be the first or last add-on\ndisplayed for items of the price sheet.",
          "enum": [
            "first",
            "last"
          ],
          "type": "string"
        },
        "price": {
          "description": "The cost for performing retouches to item images.",
          "type": "number"
        }
      },
      "required": [
        "label",
        "price",
        "position"
      ],
      "type": "object"
    },
    "salesTaxOnDigitalDownload": {
      "description": "Denotes if the sales tax should be applied to items which are solely\na digital download.",
      "type": "boolean"
    },
    "salesTaxOnShippingCharge": {
      "description": "Denotes if the sales tax should be applied to shipping fees.",
      "type": "boolean"
    },
    "salesTaxPercentage": {
      "description": "The percentage used to calculate the sales tax from an order\nsubtotal.",
      "nullable": true,
      "type": "number"
    },
    "salesTaxStateId": {
      "description": "An identifier signifying the state or locale where the sales tax is\napplicable. The identifier is a combination of the two letter country\ncode and a two to three letter abbreviation of the state/locale\nseparated by an underscore.",
      "example": "AK",
      "nullable": true,
      "type": "string"
    },
    "salesTaxTitle": {
      "description": "A name used to refer to the tax.",
      "nullable": true,
      "type": "string"
    },
    "selfFulfilledLabCatalogId": {
      "description": "The ID of the self-fulfilled catalog which the price sheet uses.",
      "nullable": true,
      "type": "integer"
    },
    "shippingOptions": {
      "description": "An array of shipping options to be used when purchasing items from\nthe price sheet.",
      "items": {
        "description": "A custom shipping option to present when a user wants to have an\norder shipped.",
        "properties": {
          "price": {
            "description": "Decimal value of the price of the shipping option.",
            "type": "number"
          },
          "title": {
            "description": "The display title of the shipping option.",
            "type": "string"
          }
        },
        "type": "object"
      },
      "nullable": true,
      "type": "array"
    },
    "shippingTitle": {
      "description": "A descriptive title for shipping, such as \"Shipping\", \"Shipping and\nHandling\", etc.",
      "nullable": true,
      "type": "string"
    },
    "shippingType": {
      "description": "What type of shipping does the price sheet expect to use.",
      "enum": [
        "custom-options",
        "lab-shipping-costs"
      ],
      "type": "string"
    },
    "taxProfileId": {
      "description": "Id of a tax profile to associate with the price sheet. The properties\nof the tax profile such as tax rate, application to shipping/digital items,\nand localities will apply to items purchased from the price sheet.",
      "nullable": true,
      "type": "number",
      "x-internal": true
    },
    "termsOfSale": {
      "description": "Terms of sale which users must agree to before being allowed to purchase\nitems from the price sheet. Providing a null removes any existing terms of\nsale.",
      "nullable": true,
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "price-sheet"
      ],
      "type": "string"
    },
    "vatNumber": {
      "description": "VAT identification number (VATIN) used by many EU and other countries for\ntax entity identification purposes.",
      "nullable": true,
      "type": "string"
    }
  },
  "required": [
    "type",
    "name"
  ],
  "title": "Price Sheet",
  "type": "object"
}