Skip to main content
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

•Boolean!non-null

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

•DateTime!non-null

The date and time when the inventory level was created.

•String

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.

•InventoryItem!non-null

Inventory item associated with the inventory level.

•Location!non-null

The location associated with the inventory level.

•[InventoryQuantity!]!non-null

Quantities for the requested names.

•InventoryScheduledChangeConnection!non-null

Scheduled changes for the requested quantity names.

•DateTime!non-null

The date and time when the inventory level was updated.


Was this section helpful?

•query

Returns an InventoryLevel object by ID.


Was this section helpful?

•mutation

Activate an inventory item at a location.

Arguments

•Int

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

•ID!required

The ID of the inventory item to activate.

•ID!required

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

•Int

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

Anchor to stockAtLegacyLocationstockAtLegacyLocation
•BooleanDefault:false

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


Fields

•InventoryLevel

The inventory level that was activated.

•[UserError!]!non-null

The list of errors that occurred from executing the mutation.

•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

•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

•InventoryItem

The inventory item that was updated.

•[InventoryLevel!]

The activated inventory levels.

•[InventoryBulkToggleActivationUserError!]!non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

•interface

Was this section helpful?