Object Index / Definition

You are viewing an old version of the API

2019-11-20

Version 2019-11-20

• All Versions

Inventory​Transfer

A unique ID generated by Square for the InventoryTransfer.

The Square generated ID of the CatalogObject being tracked.

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

A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request.

The Square ID of the Employee responsible for the inventory transfer.

The Square ID of the Location where the related quantity of items were tracked before the transfer.

A client-generated timestamp in RFC 3339 format 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.

The number of items affected by the transfer 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.

An optional ID provided by the application to tie the InventoryTransfer to an external system.

Read-only information about the application that initiated the inventory transfer.

The InventoryState for the quantity of items being transfered.

The Square ID of the Location where the related quantity of items were tracked after the transfer.