Object Index / Definition

You are viewing an old version of the API
InventoryTransfer

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

Properties

Name Description
id
string

A unique ID generated by Square for the InventoryTransfer.

reference_id
string

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

state
string

The InventoryState for the quantity of items being transfered. See InventoryState for possible values

from_location_id
string

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

to_location_id
string

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

catalog_object_id
string

The Square generated ID of the CatalogObject being tracked.

catalog_object_type
string

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

quantity
string

Beta

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.

occurred_at
string

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.

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

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

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

created_at
string

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

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

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

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

source
SourceApplication

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

employee_id
string

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

Share Feedback

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