Object Index / Definition

You are viewing an old version of the API
Inventory​Count

Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments

Properties

Name Description
calculated_at
string

A read-only timestamp in RFC 3339 format that indicates when Square received the most recent physical count or adjustment that had an affect on the estimated count.

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.

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 estimated 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.

state
string

The current InventoryState for the related quantity of items.

Share Feedback

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