Skip to main content
Anchor to InventoryItem

InventoryItem

object

Requires read_inventory access scope or read_products access scope.

A product variant's inventory information across all locations. The inventory item connects the product variant to its inventory levels at different locations, tracking stock keeping unit (SKU), whether quantities are tracked, shipping requirements, and customs information for the product.

Learn more about inventory object relationships.

Anchor to FieldsFields

Anchor to countryCodeOfOrigincountryCodeOfOrigin
•CountryCode

The ISO 3166-1 alpha-2 country code of where the item originated from.

Anchor to countryHarmonizedSystemCodescountryHarmonizedSystemCodes
•CountryHarmonizedSystemCodeConnection!
non-null

A list of country specific harmonized system codes.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the inventory item was created.

Anchor to duplicateSkuCountduplicateSkuCount
•Int!
non-null

The number of inventory items that share the same SKU with this item.

Anchor to harmonizedSystemCodeharmonizedSystemCode
•String

The harmonized system code of the item. This must be a number between 6 and 13 digits.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to inventoryHistoryUrlinventoryHistoryUrl
•URL

The URL that points to the inventory history for the item.

Anchor to inventoryLevelinventoryLevel
•InventoryLevel

The inventory item's quantities at the specified location.

Arguments

Anchor to locationIdlocationId
•ID!
required

ID of the location for which the inventory level is requested.

Anchor to inventoryLevelsinventoryLevels
•InventoryLevelConnection!
non-null

A list of the inventory item's quantities for each location that the inventory item can be stocked at.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at
•time
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to inventory_group_id
•id
Anchor to inventory_item_id
•id
Anchor to updated_at
•time
Anchor to legacyResourceIdlegacyResourceId
•UnsignedInt64!
non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to measurementmeasurement
•InventoryItemMeasurement!
non-null

The packaging dimensions of the inventory item.

Anchor to provinceCodeOfOriginprovinceCodeOfOrigin
•String

The ISO 3166-2 alpha-2 province code of where the item originated from.

Anchor to requiresShippingrequiresShipping
•Boolean!
non-null

Whether the inventory item requires shipping.

Anchor to skusku
•String

Inventory item SKU. Case-sensitive string.

Anchor to trackedtracked
•Boolean!
non-null

Whether inventory levels are tracked for the item.

Anchor to trackedEditabletrackedEditable
•EditableProperty!
non-null

Whether the value of the tracked field for the inventory item can be changed.

Anchor to unitCostunitCost
•MoneyV2

Unit cost associated with the inventory item. Note: the user must have "View product costs" permission granted in order to access this field once product granular permissions are enabled.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the inventory item was updated.

Anchor to variantsvariants
•ProductVariantConnection

A paginated list of the variants that reference this inventory item.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to variantvariant
•ProductVariant!
non-nullDeprecated
Was this section helpful?

Anchor to QueriesQueries

Anchor to inventoryIteminventoryItem
•query

Returns an InventoryItem object by ID.

Arguments

Anchor to idid
•ID!
required

The ID of the InventoryItem to return.

Anchor to inventoryItemsinventoryItems
•query

Returns a list of inventory items.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to created_at
•time
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to sku
•string

Filter by the inventory item sku field. Learn more about SKUs.

Example:

  • sku:XYZ-12345
Anchor to updated_at
•time
Was this section helpful?

Anchor to MutationsMutations

Anchor to inventoryBulkToggleActivationinventoryBulkToggleActivation
•mutation

Activates or deactivates an inventory item at multiple locations. When you activate an InventoryItem at a Location, that location can stock and track quantities for that item. When you deactivate an inventory item at a location, the inventory item is no longer stocked at that location.

The mutation accepts an inventory item ID and a list of location-specific activation settings. It returns the updated inventory item and any activated InventoryLevel objects.

Learn more about managing inventory quantities and states.

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.

Anchor to inventoryItemUpdateinventoryItemUpdate
•mutation

Updates an InventoryItem's properties including whether inventory is tracked, cost, SKU, and whether shipping is required. Inventory items represent the goods available to be shipped to customers.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory item to update.

Anchor to inputinput
•InventoryItemInput!
required

The input fields that update an inventoryItem.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to LegacyInteroperabilityLegacyInteroperability
•interface
Anchor to NodeNode
•interface
Was this section helpful?