• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
InventoryCount

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
catalog_object_id
string

The Square generated ID of the CatalogObject being tracked.

Max Length 100
catalog_object_type
string

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

Max Length 14
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.

Max Length 100
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.

Max Length 26
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.

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

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

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

Max Length 34

Share Feedback

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