Object Index
You are viewing an old version of the API
InventoryPhysicalCount
Object Index
Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee.
For example, a physical count might come from an employee counting the item variations on hand or from syncing with an external system.
Properties
Name | Description |
---|---|
id
|
A unique Square-generated ID for the InventoryPhysicalCount. |
reference_
|
An optional ID provided by the application to tie the InventoryPhysicalCount to an external system. |
catalog_
|
The Square-generated ID of the CatalogObject being tracked. |
catalog_
|
The type of the CatalogObject being tracked. The Inventory API supports setting and reading the |
state
|
The current inventory state for the related quantity of items. |
location_
|
The Square-generated ID of the Location where the related quantity of items is being tracked. |
quantity
|
The number of items affected by the physical count as a decimal string. The number can support up to 5 digits after the decimal point. |
source
|
Read only Information about the application with which the physical count is submitted. |
employee_
|
The Square-generated ID of the Employee responsible for the physical count. |
team_
|
The Square-generated ID of the Team Member responsible for the physical count. |
occurred_
|
A client-generated RFC 3339-formatted timestamp that indicates when
the physical count was examined. For physical count updates, the Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
created_
|
Read only An RFC 3339-formatted timestamp that indicates when the physical count is received. Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |