Price Sheet Discount Collection

OpenAPI Schema

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

{
  "description": "A collection of price sheet discounts",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "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"
      },
      "title": "Price Sheet Discount",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "price-sheet-discount-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}