inventoryItems

Query inventory items — supports a search `query`, `sortKey`, and cursor paging.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the inventoryItems action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventoryitems.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query InventoryItems($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $query: String) {
  inventoryItems(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    query: $query
  ) {
    edges {
      cursor
      node {
        countryCodeOfOrigin
        createdAt
        duplicateSkuCount
        harmonizedSystemCode
        id
        inventoryHistoryUrl
        legacyResourceId
        locationsCount
        measurement
        provinceCodeOfOrigin
        requiresShipping
        sku
        tracked
        trackedEditable
        unitCost
        updatedAt
        variant
      }
    }
    nodes {
      countryCodeOfOrigin
      createdAt
      duplicateSkuCount
      harmonizedSystemCode
      id
      inventoryHistoryUrl
      legacyResourceId
      locationsCount {
        count
        precision
      }
      measurement {
        id
        weight
      }
      provinceCodeOfOrigin
      requiresShipping
      sku
      tracked
      trackedEditable {
        locked
        reason
      }
      unitCost {
        amount
        currencyCode
      }
      updatedAt
      variant {
        availableForSale
        availablePublicationsCount
        barcode
        compareAtPrice
        createdAt
        defaultCursor
        deliveryProfile
        displayName
        id
        inventoryItem
        inventoryPolicy
        inventoryQuantity
        legacyResourceId
        position
        price
        product
        publishedOnCurrentChannel
        publishedOnCurrentPublication
        requiresComponents
        selectedOptions
        sellableOnlineQuantity
        sellingPlanGroupCount
        sellingPlanGroupsCount
        showUnitPrice
        sku
        storefrontId
        taxCode
        taxable
        title
        unitPrice
        unitPriceMeasurement
        updatedAt
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | created_at | time | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | sku | string | Filter by the inventory item [`sku`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem#field-sku) field. [Learn more about SKUs](https://help.shopify.com/manual/products/details/sku). | | | - `sku:XYZ-12345` | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "query": "string"
}

Response

Read the result with {{inventoryitems.response.data.data.inventoryItems}}. If the API returns errors, the step fails and they are at {{inventoryitems.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

countryCodeOfOriginobject

createdAtobject

duplicateSkuCountobject

harmonizedSystemCodeobject

idobject

inventoryHistoryUrlobject

legacyResourceIdobject

locationsCountobject

measurementobject

provinceCodeOfOriginobject

requiresShippingobject

skuobject

trackedobject

trackedEditableobject

unitCostobject

updatedAtobject

variantobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?