InventoryItem

object

Requires read_inventory access scope or read_products access scope.

Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked. Learn more about the relationships between inventory objects.

Anchor to Fields and connectionsFields and connections

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.
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.
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.
Anchor to legacyResourceIdlegacyResourceId • UnsignedInt64!non-null: The ID of the corresponding resource in the REST Admin API.
Anchor to locationsCountlocationsCount • Count: The number of locations where this inventory item is stocked.
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 variantvariant • ProductVariant!non-null: The variant that owns this inventory item.

Was this section helpful?

Anchor to QueriesQueries

Anchor to inventoryItem inventoryItem • query: Returns an InventoryItem object by ID.
Anchor to inventoryItems inventoryItems • query: Returns a list of inventory items.

Was this section helpful?

Anchor to MutationsMutations

Anchor to inventoryBulkToggleActivation inventoryBulkToggleActivation • 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 inventoryItemUpdate inventoryItemUpdate • mutation: Updates an inventory item.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to LegacyInteroperability LegacyInteroperability • interface
Anchor to Node Node • interface

Was this section helpful?