InventoryItem object
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
-
InventoryItem.node -
InventoryLevel.item -
ProductVariant.inventoryItem -
QueryRoot.inventoryItem -
QueryRoot.inventoryItems
Mutations for InventoryItem
| inventoryItemUpdate |
Updates an inventory item. |
Implements
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
Types that return InventoryItem
-
InventoryItem.node -
InventoryLevel.item -
ProductVariant.inventoryItem -
QueryRoot.inventoryItem -
QueryRoot.inventoryItems
Mutations for InventoryItem
| inventoryItemUpdate |
Updates an inventory item. |
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItem
-
InventoryItem.node -
InventoryLevel.item -
ProductVariant.inventoryItem -
QueryRoot.inventoryItem -
QueryRoot.inventoryItems
Mutations for InventoryItem
| inventoryItemUpdate |
Updates an inventory item. |
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItemEdge
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItemEdge
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItemEdge
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItemEdge
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItemEdge
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItemEdge
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |
Types that return InventoryItemEdge
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.
On this page
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 |
last
(
Int
)
|
Returns up to the last |
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 |
last
(
Int
)
|
Returns up to the last |
query
(
String
)
|
Supported filter parameters:
See the detailed search syntax for more information about using filters. |
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
On this page
Fields
edges
([InventoryItemEdge!]!)
|
A list of edges. |
pageInfo
(PageInfo!)
|
Information to aid in pagination. |
On this page
Fields
cursor
(String!)
|
A cursor for use in pagination. |
node
(InventoryItem!)
|
The item at the end of InventoryItemEdge. |