InventorySetQuantities
Sets absolute inventory quantities for specific items, overwriting existing values.
Procedure-Specific Information
The following input can accept either a temporary table name or a JSON aggregate that matches the structure of the referenced table as a value.
- InventorySetChanges references the InventorySetChanges temporary table.
InventorySetChanges Temporary Table Columns
| Column Name | Type | Description |
| InventoryItemId | String | Specifies the inventory item to which the quantity will be set. |
| InventoryLevelLocationId | String | Specifies the location at which the quantity will be set. |
| CompareQuantity | Int | The current quantity to be compared against the persisted quantity. |
| Quantity | Int | The quantity to which the inventory quantity will be set. |
Input
| Name | Type | Description |
| Name | String | The name of the inventory quantity being modified.
The allowed values are available, on_hand. |
| Reason | String | The explanation for why the quantity is being changed, such as correction or restock.
The allowed values are correction, cycle_count_available, damaged, movement_created, movement_updated, movement_received, movement_canceled, other, promotion, quality_control, received, reservation_created, reservation_deleted, reservation_updated, restock, safety_stock, shrinkage. |
| ReferenceDocumentUri | String | A URI reference indicating the source or context of the inventory change. This may represent an app, a staff action, or a related Shopify resource such as an order or adjustment document. |
| IgnoreCompareQuantity | Boolean | Indicates whether to skip the comparison check between the current and target quantities before applying the update. |
| InventorySetChanges | String | A structured list of inventory quantities and the new values to which each should be set. |
Result Set Columns
| Name | Type | Description |
| Success | Boolean | Indicates whether the quantity update operation completed successfully. |
| Details | String | Provides additional information or messages about the execution of the operation. |
| Id | String | The unique identifier of the inventory adjustment group created by this operation. |