<- Object

Object

InventoryPhysicalCount

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.

Link to section

Properties

Link to section

id

string

A unique Square-generated ID for the InventoryPhysicalCount.

Link to section

reference_id

string

An optional ID provided by the application to tie the InventoryPhysicalCount to an external system.

Link to section

catalog_object_id

string

The Square-generated ID of the CatalogObject being tracked.

Link to section

catalog_object_type

string

The type of the CatalogObject being tracked.

The Inventory API supports setting and reading the "catalog_object_type": "ITEM_VARIATION" field value. In addition, it can also read the "catalog_object_type": "ITEM" field value that is set by the Square Restaurants app.

Link to section

state

string

The current inventory state for the related quantity of items.

Link to section

location_id

string

The Square-generated ID of the Location where the related quantity of items is being tracked.

Link to section

quantity

string

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.

Link to section

source

Read only Information about the application with which the physical count is submitted.

Link to section

employee_id

string

The Square-generated ID of the Employee responsible for the physical count.

Link to section

team_member_id

string

The Square-generated ID of the Team Member responsible for the physical count.

Link to section

occurred_at

string

A client-generated RFC 3339-formatted timestamp that indicates when the physical count was examined. For physical count updates, the occurred_at timestamp cannot be older than 24 hours or in the future relative to the time of the request.

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

Link to section

created_at

string

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