CatalogModifiers

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

Select

To retrieve all catalog modifiers:

SELECT * FROM CatalogModifiers;

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

To modify the details of an existing catalog modifier, provide 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

To delete a catalog modifier object, provide the Id of the object:

DELETE FROM CatalogModifiers WHERE Id = '32123';

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	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	False	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	True	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	True	The position of this CatalogItemModifierListInfo object within the modifier_list_info list applied to a CatalogItem instance
Type	String	True	The catalog object type to be modified.
CatalogModifierListId	String	False	The catalog modifier list's Id in which the catalog modifier object belongs to.