inventory-count.md

Inventory Count

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

Structure

InventoryCount

Fields

Name	Type	Tags	Description
catalogObjectId	string | undefined	Optional	The Square-generated ID of the CatalogObject being tracked. Constraints: Maximum Length: 100
catalogObjectType	string | undefined	Optional	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. Constraints: Maximum Length: 14
state	string | undefined	Optional	Indicates the state of a tracked item quantity in the lifecycle of goods.
locationId	string | undefined	Optional	The Square-generated ID of the Location where the related quantity of items is being tracked. Constraints: Maximum Length: 100
quantity	string | undefined	Optional	The number of items affected by the estimated count as a decimal string. Can support up to 5 digits after the decimal point. Constraints: Maximum Length: 26
calculatedAt	string | undefined	Optional	An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting the estimated count is received. Constraints: Maximum Length: 34
isEstimated	boolean | undefined	Optional	Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of any of these endpoints: BatchChangeInventory, BatchRetrieveInventoryChanges, BatchRetrieveInventoryCounts, and RetrieveInventoryChanges.

Example (as JSON)

{
  "catalog_object_id": null,
  "catalog_object_type": null,
  "state": null,
  "location_id": null,
  "quantity": null
}