InventoryAdjustments
Retrieves a single InventoryAdjustment record by its ID.
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 adjustment.
Retrieve a specific inventory adjustment by its ID:
SELECT * FROM InventoryAdjustments WHERE Id = 'UDMOEO78BG843UDJFZ'
Retrieve specific columns for an inventory adjustment:
SELECT Id, CatalogObjectId, FromState, ToState, Quantity, OccurredAt FROM InventoryAdjustments WHERE Id = 'UDMOEO78BG843UDJFZ'
Columns
| Name | Type | Description |
| Id [KEY] | String | The Square-generated ID of the InventoryAdjustment. |
| ReferenceId | String | An optional ID provided by the application to tie the adjustment to an external system. |
| FromState | String | The inventory state of the related quantity of items before the adjustment.
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. |
| ToState | String | The inventory state of the related quantity of items after the adjustment.
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. |
| LocationId | String | The Square-generated ID of the location where the related quantity of items are being tracked. |
| 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 affected by the adjustment as a decimal string. |
| TotalPriceMoneyAmount | Int64 | The total price paid for goods associated with the adjustment, in the smallest denomination of the currency. Present only if ToState is SOLD. |
| TotalPriceMoneyCurrency | String | The ISO 4217 currency code of the total price paid for goods associated with the adjustment. Present only if ToState is SOLD. |
| OccurredAt | Datetime | An RFC 3339-formatted timestamp that indicates when the adjustment was made. |
| CreatedAt | Datetime | An RFC 3339-formatted timestamp that indicates when Square received the adjustment. |
| TeamMemberId | String | The Square-generated ID of the team member responsible for the adjustment. |
| SourceProduct | String | The product type of the application that made the adjustment.
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 adjustment. Used only if SourceProduct is EXTERNAL_API. |
| SourceName | String | The display name of the application that made the adjustment. |