Skip to main content
Anchor to InventoryLevel

InventoryLevel

object

Requires read_inventory 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 canDeactivatecanDeactivate
•Boolean!
non-null

Whether the inventory items associated with the inventory level can be deactivated.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the inventory level was created.

Anchor to deactivationAlertdeactivationAlert
•String

Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to itemitem
•InventoryItem!
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
•[InventoryQuantity!]!
non-null

Quantities for the requested names.

Anchor to scheduledChangesscheduledChanges
•InventoryScheduledChangeConnection!
non-null

Scheduled changes for the requested quantity names.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the inventory level was updated.

Deprecated fields and connections

Anchor to availableavailable
•Int!
non-nullDeprecated
Anchor to incomingincoming
•Int!
non-nullDeprecated
Was this section helpful?

Anchor to QueriesQueries

Anchor to inventoryLevelinventoryLevel
•query

Returns an InventoryLevel object by ID.

Was this section helpful?

Anchor to MutationsMutations

Anchor to inventoryActivateinventoryActivate
•mutation

Activate an inventory item at a location.

Arguments

Anchor to availableavailable
•Int

The initial available quantity of the inventory item being activated at the location.

Anchor to inventoryItemIdinventoryItemId
•ID!
required

The ID of the inventory item to activate.

Anchor to locationIdlocationId
•ID!
required

The ID of the location of the inventory item being activated.

Anchor to onHandonHand
•Int

The initial on_hand quantity of the inventory item being activated at the location.

Anchor to stockAtLegacyLocationstockAtLegacyLocation
•Boolean
Default:false

Allow activation at or away from fulfillment service location with sku sharing off. This will deactivate inventory at all other locations.

Fields

Anchor to inventoryLevelinventoryLevel
•InventoryLevel

The inventory level that was activated.

Anchor to userErrorsuserErrors
•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to inventoryBulkToggleActivationinventoryBulkToggleActivation
•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.

Arguments

Anchor to inventoryItemIdinventoryItemId
•ID!
required

The ID of the inventory item to modify the activation status locations for.

Anchor to inventoryItemUpdatesinventoryItemUpdates
•[InventoryBulkToggleActivationInput!]!
required

A list of pairs of locations and activate status to update for the specified inventory item.

Fields

Anchor to inventoryIteminventoryItem
•InventoryItem

The inventory item that was updated.

Anchor to inventoryLevelsinventoryLevels
•[InventoryLevel!]

The activated inventory levels.

Anchor to userErrorsuserErrors
•[InventoryBulkToggleActivationUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Deprecated mutations

Anchor to inventoryAdjustQuantityinventoryAdjustQuantity
•mutation
Deprecated

Arguments

Anchor to inputinput
•InventoryAdjustQuantityInput!
required

Provides the input fields required to update an inventory level.

Fields

Anchor to inventoryLevelinventoryLevel
•InventoryLevel

Represents the updated inventory quantity of an inventory item at a specific location.

Anchor to userErrorsuserErrors
•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to inventoryBulkAdjustQuantityAtLocationinventoryBulkAdjustQuantityAtLocation
•mutation
Deprecated

Arguments

Anchor to inventoryItemAdjustmentsinventoryItemAdjustments
•[InventoryAdjustItemInput!]!
required

Specifies adjustments for items.

Anchor to locationIdlocationId
•ID!
required

Specifies where the item should be adjusted.

Fields

Anchor to inventoryLevelsinventoryLevels
•[InventoryLevel!]

Represents the updated inventory quantities of an inventory item at the location.

Anchor to userErrorsuserErrors
•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?