InventoryTransfers
Retrieves a single InventoryTransfer record by its ID. A WHERE Id = '...' clause is required. This is a Beta API.
Table Specific Information
Select
The provider uses the Square API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the provider.
- Id supports the following operator: =.
A WHERE clause with Id is required to retrieve an inventory transfer. Note: This is a Beta API.
Retrieve a specific inventory transfer by its ID:
SELECT * FROM InventoryTransfers WHERE Id = 'DWLETHIMG6VRD6FB0KFCD71E'
Retrieve specific columns for an inventory transfer:
SELECT Id, CatalogObjectId, FromLocationId, ToLocationId, State, Quantity, OccurredAt FROM InventoryTransfers WHERE Id = 'DWLETHIMG6VRD6FB0KFCD71E'
Columns
| Name | Type | Description |
| Id [KEY] | String | The Square-generated ID of the InventoryTransfer. |
| ReferenceId | String | An optional ID provided by the application to tie the inventory transfer to an external system. |
| State | String | The current inventory state for the related quantity of items at the destination location.
The allowed values are CUSTOM, IN_STOCK, SOLD, RETURNED_BY_CUSTOMER, RESERVED_FOR_SALE, SOLD_ONLINE, ORDERED_FROM_VENDOR, RECEIVED_FROM_VENDOR, IN_TRANSIT_TO, NONE, WASTE, UNLINKED_RETURN, COMPOSED, DECOMPOSED, SUPPORTED_BY_NEWER_VERSION, IN_TRANSIT. |
| FromLocationId | String | The Square-generated ID of the location where the related quantity of items were tracked before the transfer. |
| ToLocationId | String | The Square-generated ID of the location where the related quantity of items are tracked after the transfer. |
| CatalogObjectId | String | The Square-generated ID of the CatalogObject being tracked. |
| CatalogObjectType | String | The type of the CatalogObject being tracked. Supports ITEM_VARIATION and ITEM. |
| Quantity | String | The number of items transferred as a decimal string. |
| OccurredAt | Datetime | An RFC 3339-formatted timestamp indicating when the transfer occurred. |
| CreatedAt | Datetime | An RFC 3339-formatted timestamp indicating when Square received the transfer. |
| TeamMemberId | String | The Square-generated ID of the team member responsible for the inventory transfer. |
| SourceProduct | String | The product type of the application that made the inventory transfer.
The allowed values are SQUARE_POS, EXTERNAL_API, BILLING, APPOINTMENTS, INVOICES, ONLINE_STORE, PAYROLL, DASHBOARD, ITEM_LIBRARY_IMPORT, SQUARE_TEAM_APP, OTHER. |
| SourceApplicationId | String | The Square-assigned ID of the application that made the inventory transfer. Used only if SourceProduct is EXTERNAL_API. |
| SourceName | String | The display name of the application that made the inventory transfer. |