Represents the transfer of a quantity of product inventory at a particular time from one location to another.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | A unique ID generated by Square for the InventoryTransfer. | [optional] |
| referenceId | String | An optional ID provided by the application to tie the InventoryTransfer to an external system. | [optional] |
| state | StateEnum | The InventoryState for the quantity of items being transfered. See InventoryState for possible values | [optional] |
| fromLocationId | String | The Square ID of the Location where the related quantity of items were tracked before the transfer. | [optional] |
| toLocationId | String | The Square ID of the Location where the related quantity of items were tracked after the transfer. | [optional] |
| catalogObjectId | String | The Square generated ID of the CatalogObject being tracked. | [optional] |
| catalogObjectType | String | The CatalogObjectType of the CatalogObject being tracked.Tracking is only supported for the `ITEM_VARIATION` type. | [optional] |
| quantity | String | The number of items affected by the transfer as a decimal string. Fractional quantities are not supported. | [optional] |
| occurredAt | 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. | [optional] |
| createdAt | String | A read-only timestamp in RFC 3339 format that indicates when Square received the transfer request. | [optional] |
| source | SourceApplication | Read-only information about the application that initiated the inventory transfer. | [optional] |
| employeeId | String | The Square ID of the Employee responsible for the inventory transfer. | [optional] |
| Name | Value |
|---|---|
| CUSTOM | "CUSTOM" |
| IN_STOCK | "IN_STOCK" |
| SOLD | "SOLD" |
| RETURNED_BY_CUSTOMER | "RETURNED_BY_CUSTOMER" |
| RESERVED_FOR_SALE | "RESERVED_FOR_SALE" |
| SOLD_ONLINE | "SOLD_ONLINE" |
| ORDERED_FROM_VENDOR | "ORDERED_FROM_VENDOR" |
| RECEIVED_FROM_VENDOR | "RECEIVED_FROM_VENDOR" |
| IN_TRANSIT_TO | "IN_TRANSIT_TO" |
| NONE | "NONE" |
| WASTE | "WASTE" |
| UNLINKED_RETURN | "UNLINKED_RETURN" |