Inventory
Requires access scope.
The quantities of an inventory item that are related to a specific location. Learn more about the relationships between inventory objects.
Anchor to Fields and connectionsFields and connections
- Anchor to canDeactivatecan•
Deactivate Boolean!non-null Whether the inventory items associated with the inventory level can be deactivated.
- Anchor to createdAtcreated•
At DateTime!non-null The date and time when the inventory level was created.
- Anchor to deactivationAlertdeactivation•
Alert Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.
- •ID!non-null
A globally-unique ID.
- Anchor to itemitem•Inventory
Item!non-null Inventory item associated with the inventory level.
- Anchor to locationlocation•Location!non-null
The location associated with the inventory level.
- Anchor to quantitiesquantities•[Inventory
Quantity!]!non-null Quantities for the requested names.
- Anchor to scheduledChangesscheduled•
Changes Scheduled changes for the requested quantity names.
- Anchor to updatedAtupdated•
At DateTime!non-null The date and time when the inventory level was updated.
Deprecated fields and connections
- Anchor to availableavailable•Int!non-null
The quantity of inventory items that are available at the inventory level's associated location.
- Anchor to incomingincoming•Int!non-null
The quantity of inventory items that are going to the inventory level's associated location.
Anchor to MutationsMutations
- •mutation
Activate an inventory item at a location.
- Anchor to availableavailable•
The initial available quantity of the inventory item being activated at the location.
- Anchor to inventoryItemIdinventory•
Item Id ID!required The ID of the inventory item to activate.
- Anchor to locationIdlocation•
Id ID!required The ID of the location of the inventory item being activated.
- Anchor to onHandon•
Hand The initial on_hand quantity of the inventory item being activated at the location.
- Anchor to stockAtLegacyLocationstock•
At Legacy Location BooleanDefault:false Allow activation at or away from fulfillment service location with sku sharing off. This will deactivate inventory at all other locations.
Arguments
- Anchor to inventoryLevelinventory•
Level The inventory level that was activated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Modify the activation status of an inventory item at locations. Activating an inventory item at a particular location allows that location to stock that inventory item. Deactivating an inventory item at a location removes the inventory item's quantities and turns off the inventory item from that location.
- Anchor to inventoryItemIdinventory•
Item Id ID!required The ID of the inventory item to modify the activation status locations for.
- Anchor to inventoryItemUpdatesinventory•
Item Updates A list of pairs of locations and activate status to update for the specified inventory item.
Arguments
- Anchor to inventoryIteminventory•
Item The inventory item that was updated.
- Anchor to inventoryLevelsinventory•
Levels The activated inventory levels.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields
Deprecated mutations
- •mutation
Adjusts the inventory by a certain quantity.
- Anchor to inputinput•Inventory
Adjust Quantity Input!required Provides the input fields required to update an inventory level.
Arguments
- Anchor to inventoryLevelinventory•
Level Represents the updated inventory quantity of an inventory item at a specific location.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adjusts the inventory at a location for multiple inventory items.
- Anchor to inventoryItemAdjustmentsinventory•
Item Adjustments [InventoryAdjust Item Input!]!required Specifies adjustments for items.
- Anchor to locationIdlocation•
Id ID!required Specifies where the item should be adjusted.
Arguments
- Anchor to inventoryLevelsinventory•
Levels Represents the updated inventory quantities of an inventory item at the location.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields