InventoryItem object

Version 2020-01 (Release candidate)

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

Required access

read_inventory access scope

Connections

countryHarmonizedSystemCodes (CountryHarmonizedSystemCodeConnection!)

List of country specific harmonized system codes.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

inventoryLevels (InventoryLevelConnection!)

Paginated list of inventory levels for each location that the inventory item is stocked at.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • inventory_group_id
  • inventory_item_id
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

createdAt (DateTime!)

The date and time when the inventory item was created.

duplicateSkuCount (Int!)

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

harmonizedSystemCode (String)

The harmonized system code of the item.

id (ID!)

Globally unique identifier.

inventoryHistoryUrl (URL)

URL for inventory history web page.

inventoryLevel (InventoryLevel)

Get the inventory level at a specific location.

locationId ( ID! ) required

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

legacyResourceId (UnsignedInt64!)

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

locationsCount (Int!)

The number of locations where this inventory item is stocked.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

requiresShipping (Boolean!)

Whether the item requires shipping or not.

sku (String)

Inventory item SKU.

tracked (Boolean!)

Whether the inventory quantities of inventory levels for the item are tracked or not.

trackedEditable (EditableProperty!)

Whether changes to the inventory item tracked attribute are allowed.

unitCost (MoneyV2)

Unit cost associated with the inventory item.

updatedAt (DateTime!)

The date and time when the inventory item was updated.

variant (ProductVariant!)

The variant that owns this inventory item.

Types that return InventoryItem

Mutations for InventoryItem

inventoryItemUpdate

Updates an inventory item.

Implements

Version 2019-10 (Latest)

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

Required access

read_inventory access scope

Connections

countryHarmonizedSystemCodes (CountryHarmonizedSystemCodeConnection!)

List of country specific harmonized system codes.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

inventoryLevels (InventoryLevelConnection!)

Paginated list of inventory levels for each location that the inventory item is stocked at.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • inventory_group_id
  • inventory_item_id
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

createdAt (DateTime!)

The date and time when the inventory item was created.

duplicateSkuCount (Int!)

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

harmonizedSystemCode (String)

The harmonized system code of the item.

id (ID!)

Globally unique identifier.

inventoryHistoryUrl (URL)

URL for inventory history web page.

inventoryLevel (InventoryLevel)

Get the inventory level at a specific location.

locationId ( ID! ) required

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

legacyResourceId (UnsignedInt64!)

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

locationsCount (Int!)

The number of locations where this inventory item is stocked.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

requiresShipping (Boolean!)

Whether the item requires shipping or not.

sku (String)

Inventory item SKU.

tracked (Boolean!)

Whether the inventory quantities of inventory levels for the item are tracked or not.

trackedEditable (EditableProperty!)

Whether changes to the inventory item tracked attribute are allowed.

unitCost (MoneyV2)

Unit cost associated with the inventory item.

updatedAt (DateTime!)

The date and time when the inventory item was updated.

variant (ProductVariant!)

The variant that owns this inventory item.

Types that return InventoryItem

Mutations for InventoryItem

inventoryItemUpdate

Updates an inventory item.

Implements

Version 2019-07

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

Required access

read_inventory access scope

Connections

countryHarmonizedSystemCodes (CountryHarmonizedSystemCodeConnection!)

List of country specific harmonized system codes.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

inventoryLevels (InventoryLevelConnection!)

Paginated list of inventory levels for each location that the inventory item is stocked at.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • inventory_group_id
  • inventory_item_id
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

createdAt (DateTime!)

The date and time when the inventory item was created.

duplicateSkuCount (Int!)

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

harmonizedSystemCode (String)

The harmonized system code of the item.

id (ID!)

Globally unique identifier.

inventoryHistoryUrl (URL)

URL for inventory history web page.

inventoryLevel (InventoryLevel)

Get the inventory level at a specific location.

locationId ( ID! ) required

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

legacyResourceId (UnsignedInt64!)

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

locationsCount (Int!)

The number of locations where this inventory item is stocked.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

requiresShipping (Boolean!)

Whether the item requires shipping or not.

sku (String)

Inventory item SKU.

tracked (Boolean!)

Whether the inventory quantities of inventory levels for the item are tracked or not.

trackedEditable (EditableProperty!)

Whether changes to the inventory item tracked attribute are allowed.

unitCost (MoneyV2)

Unit cost associated with the inventory item.

updatedAt (DateTime!)

The date and time when the inventory item was updated.

variant (ProductVariant!)

The variant that owns this inventory item.

Types that return InventoryItem

Mutations for InventoryItem

inventoryItemUpdate

Updates an inventory item.

Implements

Version 2019-04

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

Required access

read_inventory access scope

Connections

countryHarmonizedSystemCodes (CountryHarmonizedSystemCodeConnection!)

List of country specific harmonized system codes.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

inventoryLevels (InventoryLevelConnection!)

Paginated list of inventory levels for each location that the inventory item is stocked at.

after ( String )

Returns the elements that come after the specified cursor.

before ( String )

Returns the elements that come before the specified cursor.

first ( Int )

Returns up to the first n elements from the list.

last ( Int )

Returns up to the last n elements from the list.

query ( String )

Supported filter parameters:

  • created_at
  • inventory_group_id
  • inventory_item_id
  • updated_at

See the detailed search syntax.

reverse ( Boolean )

Reverse the order of the underlying list.
Default value: false

Fields

countryCodeOfOrigin (CountryCode)

The ISO code of the country of origin.

createdAt (DateTime!)

The date and time when the inventory item was created.

harmonizedSystemCode (String)

The harmonized system code of the item.

id (ID!)

Globally unique identifier.

inventoryHistoryUrl (URL)

URL for inventory history web page.

inventoryLevel (InventoryLevel)

Get the inventory level at a specific location.

locationId ( ID! ) required

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

legacyResourceId (UnsignedInt64!)

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

locationsCount (Int!)

The number of locations where this inventory item is stocked.

provinceCodeOfOrigin (String)

The ISO code of the province of origin.

requiresShipping (Boolean!)

Whether the item requires shipping or not.

sku (String)

Inventory item SKU.

tracked (Boolean!)

Whether the inventory quantities of inventory levels for the item are tracked or not.

trackedEditable (EditableProperty!)

Whether changes to the inventory item tracked attribute are allowed.

unitCost (MoneyV2)

Unit cost associated with the inventory item.

updatedAt (DateTime!)

The date and time when the inventory item was updated.

variant (ProductVariant!)

The variant that owns this inventory item.

Types that return InventoryItem

Mutations for InventoryItem

inventoryItemUpdate

Updates an inventory item.

Implements

Sign up for a Partner account to get started.

Sign up