Square.Connect.Model.InventoryTransfer
November 20, 2019 ยท View on GitHub
Description
Represents the transfer of a quantity of product inventory at a particular time from one location to another.
Properties
| 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 | string | 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. 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. | [optional] [beta] |
| 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] |