FileMaster

Edit File: catalog-modifier.md

# Catalog Modifier

A modifier applicable to items at the time of sale. An example of a modifier is a Cheese add-on to a Burger item.

## Structure

`CatalogModifier`

## Fields

| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `name` | `?string` | Optional | The modifier name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. **Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
| `priceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information. | getPriceMoney(): ?Money | setPriceMoney(?Money priceMoney): void |
| `ordinal` | `?int` | Optional | Determines where this `CatalogModifier` appears in the `CatalogModifierList`. | getOrdinal(): ?int | setOrdinal(?int ordinal): void |
| `modifierListId` | `?string` | Optional | The ID of the `CatalogModifierList` associated with this modifier. | getModifierListId(): ?string | setModifierListId(?string modifierListId): void |
| `locationOverrides` | [`?(ModifierLocationOverrides[])`](../../doc/models/modifier-location-overrides.md) | Optional | Location-specific price overrides. | getLocationOverrides(): ?array | setLocationOverrides(?array locationOverrides): void |
| `imageId` | `?string` | Optional | The ID of the image associated with this `CatalogModifier` instance. Currently this image is not displayed by Square, but is free to be displayed in 3rd party applications. | getImageId(): ?string | setImageId(?string imageId): void |

## Example (as JSON)

```json
{
  "object": {
    "modifier_data": {
      "name": "Almond Milk",
      "price_money": {
        "amount": 250,
        "currency": "USD"
      }
    },
    "present_at_all_locations": true,
    "type": "MODIFIER"
  },
  "name": "name6",
  "price_money": {
    "amount": 202,
    "currency": "CNY"
  },
  "ordinal": 70,
  "modifier_list_id": "modifier_list_id2",
  "location_overrides": [
    {
      "location_id": "location_id8",
      "price_money": {
        "amount": 202,
        "currency": "CNY"
      },
      "sold_out": false
    },
    {
      "location_id": "location_id8",
      "price_money": {
        "amount": 202,
        "currency": "CNY"
      },
      "sold_out": false
    },
    {
      "location_id": "location_id8",
      "price_money": {
        "amount": 202,
        "currency": "CNY"
      },
      "sold_out": false
    }
  ]
}
```

Back