Inventory
Requires access scope or 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 countryCodeOfOrigincountry•
Code Of Origin The ISO 3166-1 alpha-2 country code of where the item originated from.
- Anchor to countryHarmonizedSystemCodescountry•
Harmonized System Codes A list of country specific harmonized system codes.
- Anchor to createdAtcreated•
At DateTime!non-null The date and time when the inventory item was created.
- Anchor to duplicateSkuCountduplicate•
Sku Count Int!non-null The number of inventory items that share the same SKU with this item.
- Anchor to harmonizedSystemCodeharmonized•
System Code The harmonized system code of the item. This must be a number between 6 and 13 digits.
- •ID!non-null
A globally-unique ID.
- Anchor to inventoryHistoryUrlinventory•
History Url The URL that points to the inventory history for the item.
- Anchor to inventoryLevelinventory•
Level The inventory item's quantities at the specified location.
- Anchor to inventoryLevelsinventory•
Levels InventoryLevel Connection!non-null A list of the inventory item's quantities for each location that the inventory item can be stocked at.
- Anchor to legacyResourceIdlegacy•
Resource Id UnsignedInt64!non-null The ID of the corresponding resource in the REST Admin API.
- Anchor to locationsCountlocations•
Count The number of locations where this inventory item is stocked.
- Anchor to measurementmeasurement•Inventory
Item Measurement!non-null The packaging dimensions of the inventory item.
- Anchor to provinceCodeOfOriginprovince•
Code Of Origin The ISO 3166-2 alpha-2 province code of where the item originated from.
- Anchor to requiresShippingrequires•
Shipping Boolean!non-null Whether the inventory item requires shipping.
- •
Inventory item SKU. Case-sensitive string.
- Anchor to trackedtracked•Boolean!non-null
Whether inventory levels are tracked for the item.
- Anchor to trackedEditabletracked•
Editable EditableProperty!non-null Whether the value of the
trackedfield for the inventory item can be changed.- Anchor to unitCostunit•
Cost 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 updatedAtupdated•
At DateTime!non-null The date and time when the inventory item was updated.
- Anchor to variantvariant•Product
Variant!non-null The variant that owns this inventory item.
Anchor to QueriesQueries
- •query
Returns an InventoryItem object by ID.
- •query
Returns a list of inventory items.
Anchor to MutationsMutations
- •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 inventoryItemIdinventory•
Item Id ID!required The ID of the inventory item to modify the activation status locations for.
- Anchor to inventoryItemUpdatesinventory•
Item Updates A list of pairs of locations and activate status to update for the specified inventory item.
Arguments
- Anchor to inventoryIteminventory•
Item The inventory item that was updated.
- Anchor to inventoryLevelsinventory•
Levels The activated inventory levels.
- Anchor to userErrorsuser•
Errors The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates an inventory item.
- •ID!required
The ID of the inventory item to update.
- Anchor to inputinput•Inventory
Item Input!required
Arguments
- Anchor to inventoryIteminventory•
Item The inventory item that was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •