inventory-physical-count.md

Inventory Physical Count

Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee. For example, a physical count might come from an employee counting the item variations on hand or from syncing with an external system.

Structure

InventoryPhysicalCount

Fields

Name	Type	Tags	Description
Id	string	Optional	A unique ID generated by Square for the InventoryPhysicalCount.
ReferenceId	string	Optional	An optional ID provided by the application to tie the InventoryPhysicalCount to an external system.
CatalogObjectId	string	Optional	The Square generated ID of the CatalogObject being tracked.
CatalogObjectType	string	Optional	The CatalogObjectType of the CatalogObject being tracked. Tracking is only supported for the ITEM_VARIATION type.
State	string	Optional	Indicates the state of a tracked item quantity in the lifecycle of goods.
LocationId	string	Optional	The Square ID of the Location where the related quantity of items are being tracked.
Quantity	string	Optional	The number of items affected by the physical 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.
Source	Models.SourceApplication	Optional	Provides information about the application used to generate an inventory change.
EmployeeId	string	Optional	The Square ID of the Employee responsible for the physical count.
OccurredAt	string	Optional	A client-generated timestamp in RFC 3339 format that indicates when the physical count took place. For write actions, the occurred_at timestamp cannot be older than 24 hours or in the future relative to the time of the request.
CreatedAt	string	Optional	A read-only timestamp in RFC 3339 format that indicates when Square received the physical count.

Example (as JSON)

{
  "id": null,
  "reference_id": null,
  "catalog_object_id": null,
  "catalog_object_type": null,
  "state": null,
  "location_id": null,
  "quantity": null,
  "source": null,
  "employee_id": null,
  "occurred_at": null,
  "created_at": null
}