InventoryPhysicalCounts
Retrieves a single InventoryPhysicalCount record by its ID. A WHERE Id = '...' clause is required.
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.
- Id supports the following operator: =.
A WHERE clause with Id is required to retrieve an inventory physical count.
Retrieve a specific inventory physical count by its ID:
SELECT * FROM InventoryPhysicalCounts WHERE Id = '9NEN44MSTDE82I7VR5JH'
Retrieve specific columns for an inventory physical count:
SELECT Id, CatalogObjectId, LocationId, State, Quantity, OccurredAt FROM InventoryPhysicalCounts WHERE Id = '9NEN44MSTDE82I7VR5JH'
Columns
| Name | Type | Description |
| Id [KEY] | String | The Square-generated ID of the InventoryPhysicalCount. |
| ReferenceId | String | An optional ID provided by the application to tie the physical count to an external system. |
| 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. |
| State | String | The current inventory state for the related quantity of items.
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. |
| LocationId | String | The Square-generated ID of the location where the related quantity of items are being tracked. |
| Quantity | String | The number of items affected by the physical count as a decimal string. |
| TeamMemberId | String | The Square-generated ID of the team member who performed the physical count. |
| OccurredAt | Datetime | An RFC 3339-formatted timestamp indicating when the physical count was taken. |
| CreatedAt | Datetime | An RFC 3339-formatted timestamp indicating when Square received the physical count. |
| SourceProduct | String | The product type of the application that submitted the physical count.
The allowed values are SQUARE_POS, EXTERNAL_API, BILLING, APPOINTMENTS, INVOICES, ONLINE_STORE, PAYROLL, DASHBOARD, ITEM_LIBRARY_IMPORT, SQUARE_TEAM_APP, OTHER. |
| SourceApplicationId | String | The Square-assigned ID of the application that submitted the physical count. Used only if SourceProduct is EXTERNAL_API. |
| SourceName | String | The display name of the application that submitted the physical count. |