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

•

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

Anchor to countryHarmonizedSystemCodescountryHarmonizedSystemCodes
•

A list of country specific harmonized system codes.

•
DateTime!non-null

The date and time when the inventory item was created.

•
Int!non-null

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

Anchor to harmonizedSystemCodeharmonizedSystemCode
•

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

•
ID!non-null

A globally-unique ID.

•

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

•

The inventory item's quantities at the specified location.

•

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

•

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

•

The number of locations where this inventory item is stocked.

•

The packaging dimensions of the inventory item.

Anchor to provinceCodeOfOriginprovinceCodeOfOrigin
•

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

•
Boolean!non-null

Whether the inventory item requires shipping.

•

Inventory item SKU. Case-sensitive string.

•
Boolean!non-null

Whether inventory levels are tracked for the item.

•

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

•

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.

•
DateTime!non-null

The date and time when the inventory item was updated.

•

The variant that owns this inventory item.


Was this section helpful?

•
query

Returns an InventoryItem object by ID.

•
query

Returns a list of inventory items.


Was this section helpful?

•
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.

•
mutation

Updates an inventory item.


Was this section helpful?


Was this section helpful?