Price Sheet Discount

Description

price-sheet-discount
Price Sheet Discount

A discount for items within the price sheet.

Properties

Property Description
appliedType nullable
string
enum
  • automatic
  • promo

Whether the discount is applied automatically or with a promo code.
cartLimit nullable
integer

Maximum number of times this discount may be used in a single cart.
collections
object[]
Price Sheet Discount Collection Entry

Item or category collections this discount applies to.
created read-only
string
date-time

The creation date of this price sheet discount.
description nullable read-only
string

Studio-facing summary of the discount, generated from its settings.
discountType nullable
string
enum
  • item
  • category
  • package
  • bsgs
  • cart
  • credit

The kind of price sheet discount.
displayOrder nullable
integer

Display order of the discount on the price sheet.
expiration nullable
string
date-time

Expiration date of the discount. Null when it does not expire.
globalLimit nullable
integer

Maximum number of times this discount may be redeemed across all carts.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
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 discount.
prices
object[]
Price Sheet Discount Price

Price rows for this discount, including cart spend ranges.
promoCode nullable
string

Promo code required when appliedType is promo.
type
string
enum
  • price-sheet-discount
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 discount for items within the price sheet.",
  "properties": {
    "appliedType": {
      "description": "Whether the discount is applied automatically or with a promo code.",
      "enum": [
        "automatic",
        "promo"
      ],
      "nullable": true,
      "type": "string"
    },
    "cartLimit": {
      "description": "Maximum number of times this discount may be used in a single cart.",
      "nullable": true,
      "type": "integer"
    },
    "collections": {
      "description": "Item or category collections this discount applies to.",
      "items": {
        "$ref": "#/components/schemas/PriceSheetDiscountCollectionEntry"
      },
      "type": "array"
    },
    "created": {
      "description": "The creation date of this price sheet discount.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "description": {
      "description": "Studio-facing summary of the discount, generated from its settings.",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "discountType": {
      "description": "The kind of price sheet discount.",
      "enum": [
        "item",
        "category",
        "package",
        "bsgs",
        "cart",
        "credit"
      ],
      "nullable": true,
      "type": "string"
    },
    "displayOrder": {
      "description": "Display order of the discount on the price sheet.",
      "nullable": true,
      "type": "integer"
    },
    "expiration": {
      "description": "Expiration date of the discount. Null when it does not expire.",
      "format": "date-time",
      "nullable": true,
      "type": "string"
    },
    "globalLimit": {
      "description": "Maximum number of times this discount may be redeemed across all carts.",
      "nullable": true,
      "type": "integer"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the price sheet discount.",
      "type": "string"
    },
    "prices": {
      "description": "Price rows for this discount, including cart spend ranges.",
      "items": {
        "$ref": "#/components/schemas/PriceSheetDiscountPrice"
      },
      "type": "array"
    },
    "promoCode": {
      "description": "Promo code required when appliedType is promo.",
      "nullable": true,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "enum": [
            "price-sheet-discount"
          ]
        },
        {
          "$ref": "#/components/schemas/Type"
        }
      ]
    }
  },
  "required": [
    "type",
    "name",
    "discountType",
    "appliedType"
  ],
  "title": "Price Sheet Discount",
  "type": "object"
}
Price Sheet Discount