<- Object

Object

All versions ->

InventoryTransfer

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

Link to section

Properties

Link to section

id

string

A unique ID generated by Square for the InventoryTransfer.

Link to section

reference_id

string

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

Link to section

state

string

Link to section

from_location_id

string

The Square-generated ID of the Location where the related quantity of items was tracked before the transfer.

Link to section

to_location_id

string

The Square-generated ID of the Location where the related quantity of items was tracked after the transfer.

Link to section

catalog_object_id

string

Link to section

catalog_object_type

string

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.

Link to section

quantity

string

The number of items affected by the transfer as a decimal string. Can support up to 5 digits after the decimal point.

Link to section

occurred_at

string

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.

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

Link to section

created_at

string

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

Link to section

source

Read only Information about the application that initiated the inventory transfer.

Link to section

employee_id

string

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

Link to section

team_member_id

string

The Square-generated ID of the Team Member responsible for the inventory transfer.