catalog-modifier.md

Catalog Modifier

A modifier applicable to items at the time of sale.

Structure

CatalogModifier

Fields

Name	Type	Tags	Description
name	string | undefined	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
priceMoney	Money | undefined	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 for more information.
ordinal	number | undefined	Optional	Determines where this CatalogModifier appears in the CatalogModifierList.
modifierListId	string | undefined	Optional	The ID of the CatalogModifierList associated with this modifier.
imageId	string | undefined	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.

Example (as JSON)

{
  "object": {
    "modifier_data": {
      "name": "Almond Milk",
      "price_money": {
        "amount": 250,
        "currency": "USD"
      }
    },
    "present_at_all_locations": true,
    "type": "MODIFIER"
  }
}