inventoryEntries

Query inventory entries — supports a `where` predicate, `sort`, and `limit`/`offset` paging.

Use it in a workflow

Add a step and choose the Commercetools connector.
Pick the inventoryEntries action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventoryentries.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 InventoryEntries($where: String, $sort: [String!], $limit: Int, $offset: Int) {
  inventoryEntries(where: $where, sort: $sort, limit: $limit, offset: $offset) {
    offset
    count
    total
    exists
    results {
      sku
      quantityOnStock
      availableQuantity
      key
      restockableInDays
      reservationExpirationInMinutes
      supplyChannel {
        id
        version
        key
        roles
        nameAllLocales
        descriptionAllLocales
        address
        geoLocation
        createdAt
        lastModifiedAt
        reviewRatingStatistics
        custom
        createdBy
        lastModifiedBy
      }
      expectedDelivery
      stockLevels {
        safetyStock
        reorderPoint
      }
      supplyChannelRef {
        typeId
        id
      }
      minCartQuantity
      maxCartQuantity
      custom {
        typeRef
        type
      }
      id
      version
      createdAt
      lastModifiedAt
      createdBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
      lastModifiedBy {
        isPlatformClient
        clientId
        externalUserId
        anonymousId
        customerRef
        userRef
        associateRef
        attributedTo
      }
    }
  }
}

Variables

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

wherestring

sortarray<string>

limitnumber

offsetnumber

json

{
  "where": "string",
  "sort": [
    "string"
  ],
  "limit": 0,
  "offset": 0
}

Response

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

offsetnumber

countnumber

totalstring

existsboolean

resultsarray<object>

skuobject

quantityOnStockobject

availableQuantityobject

keyobject

restockableInDaysobject

reservationExpirationInMinutesobject

supplyChannelobject

expectedDeliveryobject

stockLevelsobject

supplyChannelRefobject

minCartQuantityobject

maxCartQuantityobject

customobject

idobject

versionobject

createdAtobject

lastModifiedAtobject

createdByobject

lastModifiedByobject

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

Was this page helpful?