InventoryTransfer
July 10, 2019 ยท View on GitHub
squareconnect.models.inventory_transfer
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 | str | A unique ID generated by Square for the InventoryTransfer. | [optional] |
| reference_id | str | An optional ID provided by the application to tie the InventoryTransfer to an external system. | [optional] |
| state | str | The InventoryState for the quantity of items being transfered. See InventoryState for possible values | [optional] |
| from_location_id | str | The Square ID of the Location where the related quantity of items were tracked before the transfer. | [optional] |
| to_location_id | str | The Square ID of the Location where the related quantity of items were tracked after the transfer. | [optional] |
| catalog_object_id | str | The Square generated ID of the CatalogObject being tracked. | [optional] |
| catalog_object_type | str | The CatalogObjectType of the CatalogObject being tracked.Tracking is only supported for the `ITEM_VARIATION` type. | [optional] |
| quantity | str | 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] |
| occurred_at | str | 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] |
| created_at | str | 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] |
| employee_id | str | The Square ID of the Employee responsible for the inventory transfer. | [optional] |