Skip to content

Latest commit

 

History

History
23 lines (18 loc) · 2.68 KB

InventoryTransfer.md

File metadata and controls

23 lines (18 loc) · 2.68 KB
Raw

SquareConnect.InventoryTransfer

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]
reference_id 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]
from_location_id String The Square ID of the `Location` where the related quantity of items were tracked before the transfer. [optional]
to_location_id String The Square ID of the `Location` where the related quantity of items were tracked after the transfer. [optional]
catalog_object_id String The Square generated ID of the `CatalogObject` being tracked. [optional]
catalog_object_type 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]
occurred_at 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]
created_at 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]
employee_id String The Square ID of the `Employee` responsible for the inventory transfer. [optional]