CatalogItems

Query the available items.

Table Specific Information

Select

Retrieve all catalog items:

SELECT * FROM CatalogItems

Insert

To create an item, you will need to specify the Name column. All the fields that are not read-only can be specified.

INSERT INTO CatalogItems (Name) VALUES ('MyItem7')

Creating an item, by specifying aggregate columns.

INSERT INTO CatalogItems (Name, Description, IsDeleted, LabelColor,Abbreviation,AvailableOnline, AvailableForPickup, AvailableElectronically, CategoryId, TaxIds, ModifierListInfo, ProductType, SkipModifierScreen, PresentAtAllLocations, PresentAtLocationIds, AbsentAtLocationIds) 
VALUES ('MyItem7','My favorite item',false,'4ab200', 'Abbreviation', true, true, true, 'KJTFGM3N2S6ATTQFUWBO4GRF', 
'[
          "OM6KNVLNASNSVHQ3GG4CJI3E",
          "4XNDTMJBDGCRFOJISE3GV3TZ",
          "THYCNM5QNAX2ZSYQITQ2YFJQ"
        ]',
'[
          {
            "modifier_list_id": "MCBLV4WVUUZ6K3MFI33N3MJB"
          },
          {
            "modifier_list_id": "WHRXTOEYZZI4V6JHTA4PPPTX"
          }
        ]',
'APPOINTMENTS_SERVICE', true, true, 
'[
 "94BYHNBR6W57E",
 "92BYHNBR2W73E"
]',
'[
 "92BYHNBR6W73E"
]')

Update

Modify the details of an existing catalog by providing the Id of the Items object:

UPDATE CatalogItems SET Description = 'TestDesc1', Name = 'TestName1', Abbreviation = 'TestAbbreviation1', AvailableForPickup = true WHERE ID = 'SSURXB52UP6QNMHQ6XD3QY4I'

Delete

Delete a item object by providing the Id of the customer:

DELETE FROM CatalogItems WHERE Id='32123'

Columns

Name	Type	ReadOnly	Description
Id [KEY]	String	True	The item's ID.
Name	String	False	The item's name.
UpdatedAt	Datatime	True	Last modification timestamp.
IsDeleted	Boolean	False	If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.
Description	String	False	The item's description.
Abbreviation	String	False	The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used.
LabelColor	String	False	The color of the item's display label in the Square Point of Sale app.
AvailableOnline	Boolean	False	If true, the item can be added to shipping orders from the merchant's online store.
AvailableForPickup	Boolean	False	If true, the item can be added to pickup orders from the merchant's online store.
AvailableElectronically	Boolean	False	If true, the item can be added to electronically fulfilled orders from the merchant's online store.
CategoryId	String	False	The ID of the item's category, if any.
TaxIds	String	False	A set of IDs indicating the CatalogTaxes that are enabled for this item.
ModifierListInfo	String	False	Info about the modifier lists that apply to this item.
ProductType	String	False	The product type of the item. May not be changed once an item has been created.
SkipModifierScreen	Boolean	False	If true, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details.
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.
ImageId	String	False	The Id of the Image