Excel Add-In for Square

Build 22.0.8479

CatalogCategories

Query the available catalog categories.

Table Specific Information

Select

Retrieve all catalog categories:

SELECT * FROM CatalogCategories

Insert

To create an item, you will need to specify the Name column.

INSERT INTO CatalogCategories (Name) VALUES ('Cat Created 2')

Update

Modify the details of an existing CatalogCategories by providing the Id of the Categories:

UPDATE CatalogCategories SET Name = 'Cat Updated' WHERE ID = '1234'

Delete

Delete a category object by providing the Id of the Categories:

DELETE FROM CatalogCategories WHERE Id='32123'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The category's ID.

Name String False

The category's name.

UpdatedAt Datatime False

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.

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.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8479