Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Latest commit

 

History

History
19 lines (12 loc) · 1.81 KB

InventoryCount.md

File metadata and controls

19 lines (12 loc) · 1.81 KB

InventoryCount

Description

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 Type Description Notes
catalogObjectId String The Square generated ID of the `CatalogObject` being tracked. [optional]
catalogObjectType String The `CatalogObjectType` of the `CatalogObject` being tracked. Tracking is only supported for the `ITEM_VARIATION` type. [optional]
state String The current `InventoryState` for the related quantity of items. See InventoryState for possible values [optional]
locationId String The Square ID of the `Location` where the related quantity of items are being tracked. [optional]
quantity String 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. [optional] [beta]
calculatedAt 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. [optional]