Object Index / Definition

You are viewing an old version of the API
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.

Properties

Name Description
id
string

A unique ID generated by Square for the InventoryPhysicalCount.

reference_id
string

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

catalog_object_id
string

The Square generated ID of the CatalogObject being tracked.

catalog_object_type
string

The CatalogObjectType of the CatalogObject being tracked. Tracking is only supported for the ITEM_VARIATION type.

state
string

The current InventoryState for the related quantity of items.

location_id
string

The Square ID of the Location where the related quantity of items are being tracked.

quantity
string

Beta

The number of items affected by the physical count as a decimal string. Can support up to 5 digits after the decimal point.

Important: The Point of Sale app and Dashboard do not currently support decimal quantities. If a Point of Sale app or Dashboard attempts to read a decimal quantity on inventory counts or adjustments, the quantity will be rounded down to the nearest integer. For example, 2.5 will become 2, and -2.5 will become -3. Read Decimal Quantities (BETA) for more information.

source
SourceApplication

Read-only information about the application that submitted the physical count.

employee_id
string

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

occurred_at
string

A client-generated timestamp in RFC 3339 format that indicates when the physical count took place. For write actions, 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:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

created_at
string

A read-only timestamp in RFC 3339 format that indicates when Square received the physical count.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?