Retrieves detailed information about modifiers associated with Square catalog items, including pricing, availability, and location-specific settings. Modifiers represent add‑ons, options, or customizations that can be applied to an item during checkout.

Table Specific Information

CatalogModifiers returns only the MODIFIER objects in the Square catalog. These objects represent individual modifiers (optional additions or modifications to items) that belong to modifier lists.

The Catalog table is the generic counterpart. It returns objects of every catalog type in a single result set, and rather than giving each type its own columns it carries the type specific fields as a JSON document in the column matching the row type: ItemData for an item, ModifierData for a modifier, and so on. Use Catalog to search across types or when the type is not known in advance, and use CatalogModifiers or another type specific table to work with one type through individual columns. Catalog is read-only, while the type specific tables also support INSERT, UPDATE, and DELETE.

Because CatalogModifiers is restricted to MODIFIER objects, a search that matches only other catalog types returns no rows here. Run the same search against Catalog to see those matches.

Select

The provider uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the provider.

• Id supports the following operators: =, IN.
• IncludeDeletedObjects supports the following operator: =.
• Query supports the following operator: =.
• SearchText supports the following operators: =, IN.
• UpdatedAt supports the following operator: >.

Retrieve all catalog modifiers:

SELECT * FROM CatalogModifiers

Filter on Id to retrieve specific modifiers. Id = fetches a single modifier directly. Id IN is served by the batch retrieve endpoint in a single request rather than one request per Id; the endpoint takes up to 1000 Ids per request, so a longer list is split across as many requests as needed.

SELECT Id, Name, PriceMoneyAmount FROM CatalogModifiers WHERE Id = 'modifier_1'

SELECT Id, Name, PriceMoneyAmount FROM CatalogModifiers WHERE Id IN ('modifier_1', 'modifier_2')

UpdatedAt supports only the > operator, which Square applies as the start of the search window. Equality and the upper bound operators are not supported.

SELECT Id, Name, UpdatedAt FROM CatalogModifiers WHERE UpdatedAt > '2025-01-01T00:00:00Z'

Set IncludeDeletedObjects to true to return modifiers that have been deleted. A deleted modifier reports IsDeleted as true, and Square no longer returns its modifier data, so Name comes back null.

SELECT Id, Name, IsDeleted FROM CatalogModifiers WHERE IncludeDeletedObjects = true

SearchText searches the searchable attributes, such as name and description. Matching is case-insensitive, and keywords of fewer than three alphanumeric characters are ignored.

SELECT Id, Name FROM CatalogModifiers WHERE SearchText = 'Extra'

Use IN to supply up to three keywords. Square combines them with AND and matches them in any order. Square rejects a fourth keyword with the error ARRAY_LENGTH_TOO_LONG, reporting that the collection must have at most 3 items.

SELECT Id, Name FROM CatalogModifiers WHERE SearchText IN ('Extra', 'Cheese')

The Query column takes a Square CatalogQuery object, supplied as JSON, and gives access to every search Square offers. The following search types are available.

• exact_query matches an attribute against an exact value. Takes attribute_name and attribute_value.
• prefix_query matches an attribute against a leading substring. Takes attribute_name and attribute_prefix.
• range_query matches a numeric attribute against a range. Takes attribute_name, attribute_min_value, and attribute_max_value.
• sorted_attribute_query orders the results by an attribute. Takes attribute_name, sort_order, and optionally initial_attribute_value.
• set_query matches an attribute against any value in a set. Takes attribute_name and attribute_values.
• items_for_tax_query returns the items that use the given taxes. Takes tax_ids.
• items_for_modifier_list_query returns the items that use the given modifier lists. Takes modifier_list_ids.
• items_for_item_options_query returns the items that use the given item options. Takes item_option_ids.
• item_variations_for_item_option_values_query returns the item variations that carry the given item option values. Takes item_option_value_ids.
• modifiers_for_child_list_query returns the modifiers that nest the given modifier lists, matching a modifier whose child_modifier_list_ids contains any of the supplied IDs. Takes child_modifier_list_ids. This search type is in beta.

exact_query, prefix_query, range_query, and sorted_attribute_query may be set together in a single CatalogQuery. Each of set_query, items_for_tax_query, items_for_modifier_list_query, items_for_item_options_query, item_variations_for_item_option_values_query, and modifiers_for_child_list_query must be the only search type in the object.

Do not set text_query in the Query column if SearchText is also set: both write to the same search, and provider rejects the combination with an error instead of merging them. Express the whole text_query search inside the Query value, or drop it and filter with SearchText alone.

Because this table returns only MODIFIER objects, a search type that yields another catalog type produces no rows here even when it matches. items_for_tax_query, items_for_modifier_list_query, items_for_item_options_query, item_variations_for_item_option_values_query, and modifiers_for_child_list_query return other catalog types, so run those against Catalog or the appropriate type-specific tables.

Order the results by an attribute. Square preserves this ordering in the result set.

SELECT Id, Name FROM CatalogModifiers WHERE Query = '{"sorted_attribute_query":{"attribute_name":"name","sort_order":"ASC"}}'

The filters can be combined in a single WHERE clause. The provider merges them into one request, with SearchText folded into the CatalogQuery next to whatever the Query column supplies.

SELECT Id, Name FROM CatalogModifiers WHERE SearchText = 'Extra' AND Query = '{"sorted_attribute_query":{"attribute_name":"name","sort_order":"ASC"}}' AND IncludeDeletedObjects = true

Insert

To create a modifier, provide the Id of the modifier list you want to add the modifier into:

INSERT INTO CatalogModifiers (Name, PriceMoneyAmount, PriceMoneyCurrency, CatalogModifierListId, OnByDefault, PresentAtLocationIds) VALUES ('Test', 1243, 'USD', 'RI7JDHAXMAWFJVT6JQZ7MHVX', false, '["92BYHNBR6W77E"]')

Update

Modify the details of an existing catalog modifier by providing the Id of the modifier and the Id of its corresponding modifier list:

UPDATE CatalogModifiers SET Name = 'Test', PriceMoneyAmount = 97, PresentAtLocationIds = '["92BYHNBR6W77E", "9J0M984DXGA7W"]' WHERE Id = 'JAB5HHFFEZX5JNJHV6RNSHLL' AND CatalogModifierListId = 'RIBNJ7ZR5DUURES7TFYVDDH2'

Delete

Delete a catalog modifier by providing the Id:

DELETE FROM CatalogModifiers WHERE Id = '32123'

Bulk Delete

The maximum BatchSize supported by CatalogModifiers for a delete is 200. Note that this is lower than the 1000 Ids a batch retrieve accepts, because Square caps its catalog batch delete separately.

Stage the Ids of the modifiers to remove in a TEMP table, then delete them in a single request. Only the Id is needed on each staged row, and a row that supplies no Id is rejected before the request is sent.

INSERT INTO CatalogModifiers#TEMP (Id) VALUES ('modifier_1')

INSERT INTO CatalogModifiers#TEMP (Id) VALUES ('modifier_2')

DELETE FROM CatalogModifiers WHERE EXISTS SELECT Id FROM CatalogModifiers#TEMP

A catalog batch delete succeeds even when only some of the Ids could be removed, and Square answers with the Ids it actually deleted. The provider reports the outcome of every staged Id against that list, so query LastResultInfo#TEMP after the delete to see which rows were removed and which were not.

SELECT * FROM LastResultInfo#TEMP

Note: Deleting a catalog object also removes the objects that belong to it, such as the variations of an item or the modifiers of a modifier list. An Id staged alongside its parent can therefore report that it was not deleted, because the parent's removal had already taken it.

Note: The staged form shown above is required to reach the bulk delete endpoint. A DELETE FROM CatalogModifiers WHERE Id = '...' statement removes the same modifier but issues one request per Id.

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	Unique identifier for the modifier. Used to reference the modifier in orders, updates, or inventory adjustments.
Name	String	False	Display name of the modifier as shown in Point of Sale, online store, or receipts.
UpdatedAt	Datetime	True	Date and time when the modifier was last updated, such as a price change or name edit.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
PriceMoneyAmount	Integer	False	Monetary amount added or subtracted from the base item price when the modifier is selected.
PriceMoneyCurrency	String	False	The modifier's price currency.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.
PresentAtLocationIds	String	False	A list of locations where the object is present, even if PresentAtAllLocations is false.
AbsentAtLocationIds	String	False	A list of locations where the object is not present, even if PresentAtAllLocations is true.
Version	Int64	False	The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.
CreatedAt	Datetime	True	Date and time when the modifier was created in the catalog.
CatalogV1Ids	String	False	The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID.
OnByDefault	Boolean	False	If true, this CatalogModifier should be selected by default for this CatalogItem.
Ordinal	Integer	False	The position of this CatalogItemModifierListInfo object within the modifier_list_info list applied to a CatalogItem instance
Type	String	False	The catalog object type to be modified.
CatalogModifierListId	String	False	The catalog modifier list's Id in which the catalog modifier object belongs to.

Pseudocolumns

Pseudo column fields are used in the WHERE clause of SELECT statements (unless stated otherwise) and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
IncludeDeletedObjects	Boolean	If true, deleted objects are included in results.
SearchText	String	A keyword to search for across the searchable attributes of a catalog object, such as name, description, and SKU. Matching is case-insensitive, and keywords of fewer than three alphanumeric characters are ignored. Use IN to supply up to three keywords, which are combined with AND in any order; Square rejects a fourth.
Query	String	A Square CatalogQuery object, supplied as JSON, giving full access to every search Square offers. Any of exact_query, prefix_query, range_query, sorted_attribute_query, and text_query may be set together. Each of set_query, items_for_tax_query, items_for_modifier_list_query, items_for_item_options_query, item_variations_for_item_option_values_query, and modifiers_for_child_list_query must be the only search set. This table returns only MODIFIER objects, so a search that matches other catalog types returns no rows. Do not set text_query here; this table builds it from the SearchText column.