InventoryItem

Required access

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.

Show definition
# Represents the goods available to be shipped to a customer.
# It holds essential information about the goods, including SKU and whether it is tracked.
type InventoryItem implements Node {
  # Globally unique identifier.
  id: ID!

  # The date and time when the inventory item was created.
  createdAt: DateTime!

  # URL for inventory history web page.
  inventoryHistoryUrl: URL

  # Get the inventory level at a specific location.
  inventoryLevel(
    # ID of the location for which the inventory level is requested.
    locationId: ID!
  ): InventoryLevel

  # Paginated list of inventory levels for each location that the inventory item is stocked at.
  inventoryLevels(
    # Returns up to the first `n` elements from the list.
    first: Int

    # Returns the elements that come after the specified cursor.
    after: String

    # Returns up to the last `n` elements from the list.
    last: Int

    # Returns the elements that come before the specified cursor.
    before: String

    # Reverse the order of the underlying list.
    reverse: Boolean = false

    # Supported filter parameters:
    #  - `inventory_item_id`
    #  - `inventory_group_id`
    #  - `updated_at`
    #  - `created_at`
    query: String
  ): InventoryLevelConnection!

  # The number of locations where this inventory item is stocked.
  locationsCount: Int!

  # Whether the item requires shipping or not.
  requiresShipping: Boolean!

  # Inventory item SKU.
  sku: String

  # Whether the inventory quantities of inventory levels for the item are tracked or not.
  tracked: Boolean!

  # The date and time when the inventory item was updated.
  updatedAt: DateTime!
}

Implements

Connections

inventoryLevels   (InventoryLevelConnection!)

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

Argument Type Default Description
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:

  • inventory_item_id
  • inventory_group_id
  • updated_at
  • created_at
reverse Boolean false

Reverse the order of the underlying list.

Fields

createdAt   (DateTime!)

The date and time when the inventory item was created.

id   (ID!)

Globally unique identifier.

inventoryHistoryUrl   (URL)

URL for inventory history web page.

inventoryLevel   (InventoryLevel)

Get the inventory level at a specific location.

Argument Type Default Description
locationId required ID!

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

locationsCount   (Int!)

The number of locations where this inventory item is stocked.

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.

updatedAt   (DateTime!)

The date and time when the inventory item was updated.