inventory-transfer.md

Inventory Transfer

Represents the transfer of a quantity of product inventory at a particular time from one location to another.

Structure

InventoryTransfer

Fields

Name	Type	Tags	Description
id	string | undefined	Optional	A unique ID generated by Square for the InventoryTransfer. Constraints: Maximum Length: 100
referenceId	string | undefined	Optional	An optional ID provided by the application to tie the InventoryTransfer to an external system. Constraints: Maximum Length: 255
state	string | undefined	Optional	Indicates the state of a tracked item quantity in the lifecycle of goods.
fromLocationId	string | undefined	Optional	The Square-generated ID of the Location where the related quantity of items was tracked before the transfer. Constraints: Maximum Length: 100
toLocationId	string | undefined	Optional	The Square-generated ID of the Location where the related quantity of items was tracked after the transfer. Constraints: Maximum Length: 100
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
quantity	string | undefined	Optional	The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. Constraints: Maximum Length: 26
occurredAt	string | undefined	Optional	A client-generated RFC 3339-formatted timestamp that indicates when the transfer 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. Constraints: Maximum Length: 34
createdAt	string | undefined	Optional	An RFC 3339-formatted timestamp that indicates when Square received the transfer request. Constraints: Maximum Length: 34
source	SourceApplication | undefined	Optional	Represents information about the application used to generate a change.
employeeId	string | undefined	Optional	The Square-generated ID of the Employee responsible for the inventory transfer. Constraints: Maximum Length: 100
teamMemberId	string | undefined	Optional	The Square-generated ID of the Team Member responsible for the inventory transfer. Constraints: Maximum Length: 100

Example (as JSON)

{
  "id": null,
  "reference_id": null,
  "state": null,
  "from_location_id": null,
  "to_location_id": null,
  "catalog_object_id": null,
  "catalog_object_type": null,
  "quantity": null,
  "occurred_at": null,
  "source": null,
  "employee_id": null,
  "team_member_id": null
}