CatalogItemOptions

Create, update, and query catalog item option objects in Square. Item options define selector attributes (e.g., color, size) that apply across multiple item variations.

Table Specific Information

CatalogItemOptions returns only the ITEM_OPTION objects in the Square catalog. The component restricts every request to that one catalog type, so each row is an item option and each of the option's fields is available as its own typed column, such as Name, DisplayName, ShowColors, and Values.

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, ItemOptionData for an item option, and so on. Use Catalog to search across types or when the type is not known in advance, and use CatalogItemOptions 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 CatalogItemOptions is restricted to ITEM_OPTION 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 component 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 component.

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 item options:

SELECT * FROM CatalogItemOptions

Filter on Id to retrieve specific item options. Id = fetches a single item option 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, DisplayName FROM CatalogItemOptions WHERE Id = 'item_option_1'

SELECT Id, Name, DisplayName FROM CatalogItemOptions WHERE Id IN ('item_option_1', 'item_option_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 CatalogItemOptions WHERE UpdatedAt > '2025-01-01T00:00:00Z'

Set IncludeDeletedObjects to true to return item options that have been deleted. A deleted item option reports IsDeleted as true.

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

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

SELECT Id, Name FROM CatalogItemOptions WHERE SearchText = 'Size'

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 CatalogItemOptions WHERE SearchText IN ('Size', 'Option')

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 component 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 ITEM_OPTION 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.

Match an attribute exactly, or by prefix:

SELECT Id, Name FROM CatalogItemOptions WHERE Query = '{"exact_query":{"attribute_name":"name","attribute_value":"Size"}}'

SELECT Id, Name FROM CatalogItemOptions WHERE Query = '{"prefix_query":{"attribute_name":"name","attribute_prefix":"Siz"}}'

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

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

Match an attribute against a set of values. In Catalog the result set is the union of the matches across every type; here it is narrowed to the item options among them.

SELECT Id, Name FROM CatalogItemOptions WHERE Query = '{"set_query":{"attribute_name":"name","attribute_values":["Size","Color"]}}'

Combine a filtering search with a sort in one CatalogQuery:

SELECT Id, Name FROM CatalogItemOptions WHERE Query = '{"prefix_query":{"attribute_name":"name","attribute_prefix":"Siz"},"sorted_attribute_query":{"attribute_name":"name","sort_order":"DESC"}}'

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

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

Insert

To create a catalog item option, you must specify the Id column. Use Name and DisplayName to describe the option (for example, Color or Size). Note: Square requires at least one option value to be embedded in the Values column when creating an item option.

INSERT INTO CatalogItemOptions (Id, Name, DisplayName, ShowColors, Values) VALUES ('#new-item-option', 'Color', 'Color', true, '[{"type":"ITEM_OPTION_VAL","id":"#new-option-value","item_option_value_data":{"name":"Red","item_option_id":"#new-item-option","ordinal":1}}]')

Update

Modify the details of an existing catalog item option by providing the Id. When updating, provide the Version to match the current version in the database.

UPDATE CatalogItemOptions SET Name = 'Updated Color', Description = 'Updated description', Version = 1 WHERE Id = 'item_option_id_here'

Delete

Delete a catalog item option by providing the Id:

DELETE FROM CatalogItemOptions WHERE Id = 'item_option_id_here'

Bulk Delete

The maximum BatchSize supported by CatalogItemOptions 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 item options 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 CatalogItemOptions#TEMP (Id) VALUES ('item_option_1')

INSERT INTO CatalogItemOptions#TEMP (Id) VALUES ('item_option_2')

DELETE FROM CatalogItemOptions WHERE EXISTS SELECT Id FROM CatalogItemOptions#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 component 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 CatalogItemOptions WHERE Id = '...' statement removes the same item option but issues one request per Id.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The item option's ID.
UpdatedAt	Datetime	True	Date and time when the item option was last modified.
IsDeleted	Boolean	False	If true, the object has been deleted from the database.
Version	Int64	False	The version of the object. When updating, the version supplied must match the version in the database.
PresentAtAllLocations	Boolean	False	If true, this object is present at all locations.
PresentAtLocationIds	String	False	A list of locations where the object is present.
AbsentAtLocationIds	String	False	A list of locations where the object is not present.
Name	String	False	The item option's display name for the seller. Must be unique across all item options.
DisplayName	String	False	The item option's display name for the customer.
Description	String	False	The item option's human-readable description. Displayed in the Square Point of Sale app for the seller and in the Online Store or on receipts for the buyer.
ShowColors	Boolean	False	If true, display colors for entries in item_option_values. Only valid for Options with a single selection.
Values	String	False	A list of CatalogObjects containing the ItemOptionValues for this ItemOption.
CreatedAt	Datetime	True	Date and time when the item option was first created in the catalog.

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 ITEM_OPTION 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.

SSIS Components for Square