stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > InventoryItem

AdminTypes.InventoryItem interface

Represents the goods available to be shipped to a customer. It holds essential information about the goods, including SKU and whether it is tracked.

Signature:

export interface InventoryItem extends LegacyInteroperability, Node 

Extends: LegacyInteroperability, Node

Properties

Property Modifiers Type Description
countryCodeOfOrigin?   Maybe<CountryCode | `${CountryCode}`> (Optional) The ISO 3166-1 alpha-2 country code of where the item originated from.
countryHarmonizedSystemCodes   CountryHarmonizedSystemCodeConnection A list of country specific harmonized system codes.
createdAt   Scalars[‘DateTime’][‘output’] The date and time when the inventory item was created.
duplicateSkuCount   Scalars[‘Int’][‘output’] The number of inventory items that share the same SKU with this item.
harmonizedSystemCode?   Maybe<Scalars[‘String’][‘output’]> (Optional) The harmonized system code of the item.
id   Scalars[‘ID’][‘output’] A globally-unique ID.
inventoryHistoryUrl?   Maybe<Scalars[‘URL’][‘output’]> (Optional) The URL that points to the inventory history for the item.
inventoryLevel?   Maybe<InventoryLevel> (Optional) The inventory item’s quantities at the specified location.
inventoryLevels   InventoryLevelConnection A list of the inventory item’s quantities for each location that the inventory item can be stocked at.
legacyResourceId   Scalars[‘UnsignedInt64’][‘output’] The ID of the corresponding resource in the REST Admin API.
locationsCount   Scalars[‘Int’][‘output’] The number of locations where this inventory item is stocked.
provinceCodeOfOrigin?   Maybe<Scalars[‘String’][‘output’]> (Optional) The ISO 3166-2 alpha-2 province code of where the item originated from.
requiresShipping   Scalars[‘Boolean’][‘output’] Whether the inventory item requires shipping.
sku?   Maybe<Scalars[‘String’][‘output’]> (Optional) Inventory item SKU. Case-sensitive string.
tracked   Scalars[‘Boolean’][‘output’] Whether inventory levels are tracked for the item.
trackedEditable   EditableProperty Whether the value of the tracked field for the inventory item can be changed.
unitCost?   Maybe<MoneyV2> (Optional) 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.
updatedAt   Scalars[‘DateTime’][‘output’] The date and time when the inventory item was updated.
variant   ProductVariant The variant that owns this inventory item.