InventoryCounts
Query current inventory counts in Square using a batch POST retrieval endpoint. Supports filtering by CatalogObjectId, LocationId, and State.
Table Specific Information
Select
The add-in 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 add-in.
- CalculatedAt supports the following operators: =, >=, <=, >, <.
- CatalogObjectId supports the following operators: =, IN.
- LocationId supports the following operators: =, IN.
- State supports the following operators: =, IN.
Retrieve all inventory counts:
SELECT * FROM InventoryCounts
Retrieve inventory counts for a specific catalog object:
SELECT * FROM InventoryCounts WHERE CatalogObjectId = 'ITEM_VARIATION_ID'
Retrieve inventory counts for a specific location:
SELECT * FROM InventoryCounts WHERE LocationId = '92BYHNBR6W77E'
Retrieve in-stock inventory counts:
SELECT * FROM InventoryCounts WHERE State = 'IN_STOCK'
Retrieve inventory counts updated after a specific date:
SELECT * FROM InventoryCounts WHERE CalculatedAt >= '2024-01-01T00:00:00Z'
Columns
| Name | Type | Description |
| CatalogObjectId | String | The Square-generated ID of the CatalogObject being tracked. |
| CatalogObjectType | String | The type of the CatalogObject being tracked. Supports ITEM_VARIATION and ITEM (set by Square Restaurants app). |
| LocationId | String | The Square-generated ID of the Location where the related quantity of items is being tracked. |
| State | String | The current inventory state for the related quantity of items. Filter note: NONE, SOLD, and UNLINKED_RETURN are ignored when used as filters.
The allowed values are CUSTOM, IN_STOCK, SOLD, RETURNED_BY_CUSTOMER, RESERVED_FOR_SALE, SOLD_ONLINE, ORDERED_FROM_VENDOR, RECEIVED_FROM_VENDOR, IN_TRANSIT_TO, NONE, WASTE, UNLINKED_RETURN, COMPOSED, DECOMPOSED, SUPPORTED_BY_NEWER_VERSION, IN_TRANSIT. |
| Quantity | String | The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. |
| IsEstimated | Boolean | Whether the inventory quantity is for an estimated count. Set when retrieved from BatchRetrieveInventoryCounts. |
| CalculatedAt | Datetime | An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting the estimated count is received. |