Object Index
/ Definition
You are viewing an old version of the API
InventoryTransfer
Object Index / Definition
Represents the transfer of a quantity of product inventory at a particular time from one location to another.
Properties
| Name | Description |
|---|---|
id
|
A unique ID generated by Square for the
|
reference_id
|
An optional ID provided by the application to tie the
|
state
|
The |
from_location_id
|
The Square ID of the Location where the related quantity of items were tracked before the transfer. |
to_location_id
|
The Square ID of the Location where the related quantity of items were tracked after the transfer. |
catalog_object_id
|
The Square generated ID of the
|
catalog_object_type
|
The |
quantity
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, |
occurred_at
|
A client-generated timestamp in RFC 3339 format that indicates when
the transfer took place. For write actions, the 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
|
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
|
Read-only information about the application that initiated the inventory transfer. |
employee_id
|
The Square ID of the Employee responsible for the inventory transfer. |