Represents the estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments.
| 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 | StateEnum | 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 in the count as a decimal string. Fractional quantities are not supported. | [optional] |
| 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] |
| Name | Value |
|---|---|
| CUSTOM | "CUSTOM" |
| IN_STOCK | "IN_STOCK" |
| SOLD | "SOLD" |
| RETURNED_BY_CUSTOMER | "RETURNED_BY_CUSTOMER" |
| RESERVED_FOR_SALE | "RESERVED_FOR_SALE" |
| SOLD_ONLINE | "SOLD_ONLINE" |
| ORDERED_FROM_VENDOR | "ORDERED_FROM_VENDOR" |
| RECEIVED_FROM_VENDOR | "RECEIVED_FROM_VENDOR" |
| IN_TRANSIT_TO | "IN_TRANSIT_TO" |
| NONE | "NONE" |
| WASTE | "WASTE" |
| UNLINKED_RETURN | "UNLINKED_RETURN" |