FileMaster

Edit File: catalog-product-set.md

# Catalog Product Set

Represents a collection of catalog objects for the purpose of applying a
`PricingRule`. Including a catalog object will include all of its subtypes.
For example, including a category in a product set will include all of its
items and associated item variations in the product set. Including an item in
a product set will also include its item variations.

## Structure

`CatalogProductSet`

## Fields

| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `name` | `?string` | Optional | User-defined name for the product set. For example, "Clearance Items" or "Winter Sale Items". | getName(): ?string | setName(?string name): void |
| `productIdsAny` | `?(string[])` | Optional | Unique IDs for any `CatalogObject` included in this product set. Any number of these catalog objects can be in an order for a pricing rule to apply. This can be used with `product_ids_all` in a parent `CatalogProductSet` to match groups of products for a bulk discount, such as a discount for an entree and side combo. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | getProductIdsAny(): ?array | setProductIdsAny(?array productIdsAny): void |
| `productIdsAll` | `?(string[])` | Optional | Unique IDs for any `CatalogObject` included in this product set. All objects in this set must be included in an order for a pricing rule to apply. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. Max: 500 catalog object IDs. | getProductIdsAll(): ?array | setProductIdsAll(?array productIdsAll): void |
| `quantityExact` | `?int` | Optional | If set, there must be exactly this many items from `products_any` or `products_all` in the cart for the discount to apply. Cannot be combined with either `quantity_min` or `quantity_max`. | getQuantityExact(): ?int | setQuantityExact(?int quantityExact): void |
| `quantityMin` | `?int` | Optional | If set, there must be at least this many items from `products_any` or `products_all` in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if `quantity_exact`, `quantity_min` and `quantity_max` are all unspecified. | getQuantityMin(): ?int | setQuantityMin(?int quantityMin): void |
| `quantityMax` | `?int` | Optional | If set, the pricing rule will apply to a maximum of this many items from `products_any` or `products_all`. | getQuantityMax(): ?int | setQuantityMax(?int quantityMax): void |
| `allProducts` | `?bool` | Optional | If set to `true`, the product set will include every item in the catalog. Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. | getAllProducts(): ?bool | setAllProducts(?bool allProducts): void |

## Example (as JSON)

```json
{
  "name": "name6",
  "product_ids_any": [
    "product_ids_any8"
  ],
  "product_ids_all": [
    "product_ids_all7"
  ],
  "quantity_exact": 222,
  "quantity_min": 100
}
```

Back