Object Index
You are viewing an old version of the API
InventoryTransfer
Object Index
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_
|
An optional ID provided by the application to tie the
|
state
|
The inventory state for the quantity of items being transferred. |
from_
|
The Square-generated ID of the Location where the related quantity of items was tracked before the transfer. |
to_
|
The Square-generated ID of the Location where the related quantity of items was tracked after the transfer. |
catalog_
|
The Square-generated ID of the CatalogObject being tracked. |
catalog_
|
The type of the CatalogObject being tracked. The Inventory API supports setting and reading the |
quantity
|
The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point. |
occurred_
|
A client-generated RFC 3339-formatted timestamp that indicates when
the transfer took place. For write actions, the Examples for January 25th, 2020 6:25:34pm Pacific Standard Time: UTC: 2020-01-26T02:25:34Z Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 |
created_
|
Read only An RFC 3339-formatted timestamp that indicates when Square received the transfer request. Examples for January 25th, 2020 6:25: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_
|
The Square-generated ID of the Employee responsible for the inventory transfer. |
team_
|
The Square-generated ID of the Team Member responsible for the inventory transfer. |