Price Sheet Discount Collection Entry

Description

A collection of price sheet items or groups that a discount applies to, including quantity. For buy-X-get-Y discounts, array order is buy then get.

Properties

Property Description
id

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

priceSheetGroupIds

Price sheet group identifiers in this collection.

priceSheetItemIds

Price sheet item identifiers in this collection.

quantity nullable

Quantity required or granted for this 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 items or groups that a discount applies to,\nincluding quantity. For buy-X-get-Y discounts, array order is buy then get.",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "priceSheetGroupIds": {
      "description": "Price sheet group identifiers in this collection.",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "priceSheetItemIds": {
      "description": "Price sheet item identifiers in this collection.",
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "quantity": {
      "description": "Quantity required or granted for this collection.",
      "nullable": true,
      "type": "integer"
    }
  },
  "title": "Price Sheet Discount Collection Entry",
  "type": "object"
}