> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# InventoryLevelLedgerEntry

> An append-only ledger row describing a quantity change at a bin-level inventory level.

**Required scopes:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

<ResponseField name="balance" type="Int!" required>
  On-hand quantity at this inventory level immediately after this entry.
</ResponseField>

<ResponseField name="binInventoryLevel" type={<a href="/docs/api-reference/v3/reference/inventory/bin-inventory-level">BinInventoryLevel</a>}>
  The bin-level inventory record this ledger row belongs to.

  **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

  <Expandable title="fields" lazyRender>
    <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was created.
    </ResponseField>

    <ResponseField name="id" type="ID!" required>
      The id of this bin-level inventory record.
    </ResponseField>

    <ResponseField name="inventoryItem" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-item">InventoryItem</a>}>
      The specific inventory item this level tracks, when item-scoped.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        <ResponseField name="binInventoryLevels" type={<a href="/docs/api-reference/v3/pagination">BinInventoryLevelConnection!</a>} required>
          Bin-level quantity rows for this inventory item.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="disposition" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-item-disposition">InventoryItemDisposition</a>}>
          Planned disposition for return inventory.
        </ResponseField>

        <ResponseField name="expirationDate" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
          Expiration date for lot-tracked stock. Null when the lot has no expiration set.
        </ResponseField>

        <ResponseField name="grade" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-item-grade">InventoryItemGrade</a>}>
          Condition grade, when applicable.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this inventory item.
        </ResponseField>

        <ResponseField name="itemClass" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-item-class">InventoryItemClass</a>}>
          Item classification.
        </ResponseField>

        <ResponseField name="kind" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-item-kind">InventoryItemKind!</a>} required>
          The kind of inventory unit.
        </ResponseField>

        <ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location!</a>} required>
          The warehouse this unit is associated with.

          **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
        </ResponseField>

        <ResponseField name="lotNumber" type="String">
          Lot number, when lot tracking applies.
        </ResponseField>

        <ResponseField name="product" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-product">InventoryProduct</a>}>
          The product this unit is tied to, when applicable.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
        </ResponseField>

        <ResponseField name="quantity" type="Int!" required>
          The number of units this record represents.
        </ResponseField>

        <ResponseField name="storageLocation" type={<a href="/docs/api-reference/v3/reference/inventory/storage-location">StorageLocation</a>}>
          The bin or slot where this unit currently resides.

          **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="inventoryProduct" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-product">InventoryProduct</a>}>
      The product this quantity belongs to, when the level is product-scoped.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        <ResponseField name="barcodes" type="[String!]!" required>
          Barcodes associated with this product, for scanning.
        </ResponseField>

        <ResponseField name="dimensions" type={<a href="/docs/api-reference/v3/reference/catalog/dimensions">Dimensions</a>}>
          The product's length, width, and height in a single shared unit, for box sizing.
        </ResponseField>

        <ResponseField name="hsCode" type="String">
          The Harmonized System code used for customs.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this product.
        </ResponseField>

        <ResponseField name="image" type={<a href="/docs/api-reference/v3/reference/catalog/product-image">ProductImage</a>}>
          The first (default) image for this product, if any.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
        </ResponseField>

        <ResponseField name="originCountry" type="String">
          The country of origin, as a country code, for customs.
        </ResponseField>

        <ResponseField name="sku" type="String">
          The stock keeping unit identifying this product.
        </ResponseField>

        <ResponseField name="title" type="String!" required>
          The product's title.
        </ResponseField>

        <ResponseField name="upc" type="String">
          The Universal Product Code for this product.
        </ResponseField>

        <ResponseField name="weight" type={<a href="/docs/api-reference/v3/reference/catalog/weight">Weight</a>}>
          The product's weight, for shipping.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="lastCountedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime</a>}>
      When this bin-level quantity was last cycle-counted.
    </ResponseField>

    <ResponseField name="ledgerEntries" type={<a href="/docs/api-reference/v3/pagination">InventoryLevelLedgerEntryConnection!</a>} required>
      Append-only quantity change history for this bin-level inventory record. Load via `binInventoryLevel(id) { ledgerEntries(...) }` or `StorageLocation.binInventoryLevels { ledgerEntries(...) }`.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String">
          Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
        </ResponseField>

        <ResponseField name="before" type="String">
          Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
        </ResponseField>

        <ResponseField name="createdAtAfter" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime</a>}>
          Only return entries recorded at or after this instant.
        </ResponseField>

        <ResponseField name="createdAtBefore" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime</a>}>
          Only return entries recorded before this instant.
        </ResponseField>

        <ResponseField name="first" type="Int">
          Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
        </ResponseField>

        <ResponseField name="kind" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-level-adjustment-kind">[InventoryLevelAdjustmentKind!]</a>}>
          Only return entries with one of these adjustment kinds.
        </ResponseField>

        <ResponseField name="last" type="Int">
          Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
        </ResponseField>

        <ResponseField name="orderBy" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-level-ledger-entry-sort-key">InventoryLevelLedgerEntrySortKey</a>}>
          Which key to sort by (defaults to the first key, newest-first). Combine with `reverse` to flip direction.
        </ResponseField>

        <ResponseField name="reverse" type="Boolean">
          Reverses the sort direction selected by `orderBy` (or its default).
        </ResponseField>

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[InventoryLevelLedgerEntryEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-level-ledger-entry">[InventoryLevelLedgerEntry!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location</a>}>
      The warehouse this quantity is held at.

      **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)

      <Expandable title="fields" lazyRender>
        <ResponseField name="city" type="String">
          The city of the location's address.
        </ResponseField>

        <ResponseField name="company" type="String">
          The company name associated with the location.
        </ResponseField>

        <ResponseField name="countryCode" type="String">
          The country code, e.g. "US".
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this location.
        </ResponseField>

        <ResponseField name="inventoryItems" type={<a href="/docs/api-reference/v3/pagination">InventoryItemConnection!</a>} required>
          Traceable inventory units at this warehouse.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="inventoryLevels" type={<a href="/docs/api-reference/v3/pagination">LocationInventoryLevelConnection!</a>} required>
          Per-product inventory levels held at this location.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="name" type="String!" required>
          The location's display name.
        </ResponseField>

        <ResponseField name="phone" type="String">
          The contact phone number for the location.
        </ResponseField>

        <ResponseField name="postalCode" type="String">
          The postal or ZIP code, e.g. "84101".
        </ResponseField>

        <ResponseField name="stateCode" type="String">
          The state or province code, e.g. "UT".
        </ResponseField>

        <ResponseField name="storageLocations" type={<a href="/docs/api-reference/v3/pagination">StorageLocationConnection!</a>} required>
          Bins and other storage locations within this warehouse.

          **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="street1" type="String">
          The first line of the street address.
        </ResponseField>

        <ResponseField name="street2" type="String">
          The second line of the street address.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="maxQuantity" type="Int">
      Maximum quantity allowed in the bin, when capped.
    </ResponseField>

    <ResponseField name="quantity" type="Int!" required>
      Quantity on hand in the storage location.
    </ResponseField>

    <ResponseField name="storageLocation" type={<a href="/docs/api-reference/v3/reference/inventory/storage-location">StorageLocation!</a>} required>
      The bin or slot holding this quantity.

      **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)

      <Expandable title="fields" lazyRender>
        <ResponseField name="binInventoryLevels" type={<a href="/docs/api-reference/v3/pagination">BinInventoryLevelConnection!</a>} required>
          Product quantities held in this storage location.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="inStock" type="Boolean">
              true returns only rows holding stock (quantity above zero). false returns only empty or negative rows, such as emptied assignments and LOST balancing entries.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>

            <ResponseField name="orderBy" type={<a href="/docs/api-reference/v3/reference/inventory/bin-inventory-level-sort-key">BinInventoryLevelSortKey</a>}>
              Which key to sort by (creation time, newest first). Combine with `reverse` to flip direction.
            </ResponseField>

            <ResponseField name="reverse" type="Boolean">
              Reverses the sort direction selected by `orderBy` (or its default).
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this storage location.
        </ResponseField>

        <ResponseField name="inventoryItems" type={<a href="/docs/api-reference/v3/pagination">InventoryItemConnection!</a>} required>
          Inventory items currently in this storage location.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="isSellable" type="Boolean!" required>
          Whether on-hand quantity in this slot counts as sellable inventory.
        </ResponseField>

        <ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location!</a>} required>
          The warehouse this storage location belongs to.

          **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
        </ResponseField>

        <ResponseField name="name" type="String!" required>
          The display name of the bin or slot.
        </ResponseField>

        <ResponseField name="priority" type={<a href="/docs/api-reference/v3/reference/inventory/storage-location-priority">StorageLocationPriority</a>}>
          Pick priority relative to other bins, when set.
        </ResponseField>

        <ResponseField name="source" type={<a href="/docs/api-reference/v3/reference/inventory/storage-location-source">StorageLocationSource!</a>} required>
          How this record was created.
        </ResponseField>

        <ResponseField name="stockedProductCount" type="Int!" required>
          How many product levels in this storage location have a quantity above zero.
        </ResponseField>

        <ResponseField name="totalQuantity" type="Int!" required>
          The sum of every level's quantity in this storage location.
        </ResponseField>

        <ResponseField name="type" type={<a href="/docs/api-reference/v3/reference/inventory/storage-location-type">StorageLocationType!</a>} required>
          The kind of storage location.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was last updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
  When this ledger entry was recorded.
</ResponseField>

<ResponseField name="delta" type="Int!" required>
  Signed quantity change applied by this entry (negative reduces on-hand).
</ResponseField>

<ResponseField name="expirationDate" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
  Expiration date on the linked inventory item today (not a snapshot at adjustment time).
</ResponseField>

<ResponseField name="id" type="ID!" required>
  The id of this ledger entry.
</ResponseField>

<ResponseField name="kind" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-level-adjustment-kind">InventoryLevelAdjustmentKind!</a>} required>
  What caused this inventory change.
</ResponseField>

<ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location</a>}>
  The warehouse location where this adjustment occurred.

  **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)

  <Expandable title="fields" lazyRender>
    <ResponseField name="city" type="String">
      The city of the location's address.
    </ResponseField>

    <ResponseField name="company" type="String">
      The company name associated with the location.
    </ResponseField>

    <ResponseField name="countryCode" type="String">
      The country code, e.g. "US".
    </ResponseField>

    <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was created.
    </ResponseField>

    <ResponseField name="id" type="ID!" required>
      The id of this location.
    </ResponseField>

    <ResponseField name="inventoryItems" type={<a href="/docs/api-reference/v3/pagination">InventoryItemConnection!</a>} required>
      Traceable inventory units at this warehouse.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String">
          Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
        </ResponseField>

        <ResponseField name="before" type="String">
          Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
        </ResponseField>

        <ResponseField name="first" type="Int">
          Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
        </ResponseField>

        <ResponseField name="last" type="Int">
          Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
        </ResponseField>

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[InventoryItemEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-item">[InventoryItem!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="inventoryLevels" type={<a href="/docs/api-reference/v3/pagination">LocationInventoryLevelConnection!</a>} required>
      Per-product inventory levels held at this location.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String">
          Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
        </ResponseField>

        <ResponseField name="before" type="String">
          Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
        </ResponseField>

        <ResponseField name="first" type="Int">
          Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
        </ResponseField>

        <ResponseField name="last" type="Int">
          Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
        </ResponseField>

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[LocationInventoryLevelEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/inventory/location-inventory-level">[LocationInventoryLevel!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="name" type="String!" required>
      The location's display name.
    </ResponseField>

    <ResponseField name="phone" type="String">
      The contact phone number for the location.
    </ResponseField>

    <ResponseField name="postalCode" type="String">
      The postal or ZIP code, e.g. "84101".
    </ResponseField>

    <ResponseField name="stateCode" type="String">
      The state or province code, e.g. "UT".
    </ResponseField>

    <ResponseField name="storageLocations" type={<a href="/docs/api-reference/v3/pagination">StorageLocationConnection!</a>} required>
      Bins and other storage locations within this warehouse.

      **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String">
          Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
        </ResponseField>

        <ResponseField name="before" type="String">
          Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
        </ResponseField>

        <ResponseField name="first" type="Int">
          Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
        </ResponseField>

        <ResponseField name="last" type="Int">
          Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
        </ResponseField>

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[StorageLocationEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/inventory/storage-location">[StorageLocation!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="street1" type="String">
      The first line of the street address.
    </ResponseField>

    <ResponseField name="street2" type="String">
      The second line of the street address.
    </ResponseField>

    <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was last updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="lotNumber" type="String">
  Lot number on the linked inventory item today (not a snapshot at adjustment time).
</ResponseField>

<ResponseField name="notes" type="String">
  Free-text notes stored on the entry.
</ResponseField>

<ResponseField name="product" type={<a href="/docs/api-reference/v3/reference/catalog/product">Product</a>}>
  The product whose inventory changed, when applicable.

  **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

  <Expandable title="fields" lazyRender>
    <ResponseField name="attribute" type={<a href="/docs/api-reference/v3/reference/catalog/attribute">Attribute</a>}>
      Look up a single attribute on this product by its name, if set.

      **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="name" type="String!" required>
          The machine name of the attribute to look up.
        </ResponseField>

        **Fields**

        <ResponseField name="description" type="String">
          An optional description of what the attribute represents.
        </ResponseField>

        <ResponseField name="displayName" type="String!" required>
          The human-readable label shown for the attribute.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The unique identifier of the attribute's definition.
        </ResponseField>

        <ResponseField name="name" type="String!" required>
          The attribute's machine name, unique within the account.
        </ResponseField>

        <ResponseField name="type" type={<a href="/docs/api-reference/v3/reference/catalog/attribute-type">AttributeType!</a>} required>
          The data type of the attribute's value.
        </ResponseField>

        <ResponseField name="value" type={<a href="/docs/api-reference/v3/reference/common/json">JSON</a>}>
          The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="attributes" type={<a href="/docs/api-reference/v3/reference/catalog/attribute">[Attribute!]!</a>} required>
      The merchant-defined attributes set on this product.

      <Expandable title="fields" lazyRender>
        <ResponseField name="description" type="String">
          An optional description of what the attribute represents.
        </ResponseField>

        <ResponseField name="displayName" type="String!" required>
          The human-readable label shown for the attribute.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The unique identifier of the attribute's definition.
        </ResponseField>

        <ResponseField name="name" type="String!" required>
          The attribute's machine name, unique within the account.
        </ResponseField>

        <ResponseField name="type" type={<a href="/docs/api-reference/v3/reference/catalog/attribute-type">AttributeType!</a>} required>
          The data type of the attribute's value.
        </ResponseField>

        <ResponseField name="value" type={<a href="/docs/api-reference/v3/reference/common/json">JSON</a>}>
          The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="barcodes" type="[String!]!" required>
      Barcodes associated with this product.
    </ResponseField>

    <ResponseField name="cost" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
      The merchant's unit cost for the product.

      <Expandable title="fields" lazyRender>
        <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
          The exact amount as a decimal string (e.g. "19.99").
        </ResponseField>

        <ResponseField name="currency" type="String!" required>
          ISO 4217 currency code (e.g. USD).
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was created.
    </ResponseField>

    <ResponseField name="description" type="String!" required>
      The product's long-form description.
    </ResponseField>

    <ResponseField name="dimensions" type={<a href="/docs/api-reference/v3/reference/catalog/dimensions">Dimensions</a>}>
      The product's length, width, and height, expressed in a single shared unit.

      <Expandable title="fields" lazyRender>
        <ResponseField name="height" type="Float">
          The height, in `unit`.
        </ResponseField>

        <ResponseField name="length" type="Float">
          The length, in `unit`.
        </ResponseField>

        <ResponseField name="unit" type={<a href="/docs/api-reference/v3/reference/catalog/dimension-unit">DimensionUnit!</a>} required>
          The unit all three measurements are expressed in.
        </ResponseField>

        <ResponseField name="width" type="Float">
          The width, in `unit`.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="hsCode" type="String">
      The Harmonized System code used for customs.
    </ResponseField>

    <ResponseField name="id" type="ID!" required>
      The id of this product.
    </ResponseField>

    <ResponseField name="image" type={<a href="/docs/api-reference/v3/reference/catalog/product-image">ProductImage</a>}>
      The first (default) image for this product, if any.

      **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

      <Expandable title="fields" lazyRender>
        <ResponseField name="altText" type="String!" required>
          Alternative text describing the image.
        </ResponseField>

        <ResponseField name="default" type="Boolean!" required>
          Whether this is the default image.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this image.
        </ResponseField>

        <ResponseField name="position" type="Int!" required>
          The image's ordering position.
        </ResponseField>

        <ResponseField name="url" type="String!" required>
          The public URL of the image.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="images" type={<a href="/docs/api-reference/v3/pagination">ProductImageConnection!</a>} required>
      A paginated list of the product's images.

      **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String">
          Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
        </ResponseField>

        <ResponseField name="before" type="String">
          Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
        </ResponseField>

        <ResponseField name="first" type="Int">
          Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
        </ResponseField>

        <ResponseField name="last" type="Int">
          Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
        </ResponseField>

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[ProductImageEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/catalog/product-image">[ProductImage!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="inventoryItems" type={<a href="/docs/api-reference/v3/pagination">InventoryItemConnection!</a>} required>
      Traceable inventory units for this product.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String" />

        <ResponseField name="before" type="String" />

        <ResponseField name="first" type="Int" />

        <ResponseField name="last" type="Int" />

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[InventoryItemEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-item">[InventoryItem!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="inventoryLevel" type={<a href="/docs/api-reference/v3/reference/inventory/location-inventory-level">LocationInventoryLevel</a>}>
      This product's inventory level at a single location, if any.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="locationId" type="ID!" required>
          The id of the location to fetch the level at.
        </ResponseField>

        **Fields**

        <ResponseField name="available" type="Int!" required>
          The quantity available to sell.
        </ResponseField>

        <ResponseField name="buildable" type="Int!" required>
          The quantity that can be built from components.
        </ResponseField>

        <ResponseField name="committed" type="Int!" required>
          The quantity committed to existing orders.
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this inventory level.
        </ResponseField>

        <ResponseField name="inventoryProduct" type={<a href="/docs/api-reference/v3/reference/inventory/inventory-product">InventoryProduct</a>}>
          A fulfillment-oriented view of the product, readable by anyone who can see this level (e.g. a 3PL). For the full product, use `product`.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
        </ResponseField>

        <ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location</a>}>
          The location these inventory levels are held at.

          **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
        </ResponseField>

        <ResponseField name="product" type={<a href="/docs/api-reference/v3/reference/catalog/product">Product</a>}>
          The full product these inventory levels are for. Only readable by the account that owns the product; use `inventoryProduct` otherwise.

          **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
        </ResponseField>

        <ResponseField name="quantity" type="Int!" required>
          The total quantity on hand at the location.
        </ResponseField>

        <ResponseField name="reserved" type="Int!" required>
          The quantity reserved across all reservation buckets.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="inventoryLevels" type={<a href="/docs/api-reference/v3/pagination">LocationInventoryLevelConnection!</a>} required>
      Per-location inventory levels for this product.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String">
          Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
        </ResponseField>

        <ResponseField name="before" type="String">
          Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
        </ResponseField>

        <ResponseField name="first" type="Int">
          Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
        </ResponseField>

        <ResponseField name="last" type="Int">
          Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
        </ResponseField>

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[LocationInventoryLevelEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/inventory/location-inventory-level">[LocationInventoryLevel!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="options" type={<a href="/docs/api-reference/v3/reference/catalog/product-option-value">[ProductOptionValue!]!</a>} required>
      The variant's selected option values (e.g. Size: M, Color: Red), ordered by the family's option positions.

      <Expandable title="fields" lazyRender>
        <ResponseField name="name" type="String!" required>
          The option name, e.g. Size.
        </ResponseField>

        <ResponseField name="value" type="String!" required>
          The selected value, e.g. M.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="originCountry" type="String">
      The country of origin, as a country code.
    </ResponseField>

    <ResponseField name="physicalItem" type="Boolean!" required>
      Whether the product is a physical, shippable item.
    </ResponseField>

    <ResponseField name="price" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
      The product's selling price.

      <Expandable title="fields" lazyRender>
        <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
          The exact amount as a decimal string (e.g. "19.99").
        </ResponseField>

        <ResponseField name="currency" type="String!" required>
          ISO 4217 currency code (e.g. USD).
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="productFamily" type={<a href="/docs/api-reference/v3/reference/catalog/product-family">ProductFamily</a>}>
      The product family this product belongs to, if any.

      **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

      <Expandable title="fields" lazyRender>
        <ResponseField name="attribute" type={<a href="/docs/api-reference/v3/reference/catalog/attribute">Attribute</a>}>
          Look up a single attribute on this family by its name, if set.

          **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="name" type="String!" required>
              The machine name of the attribute to look up.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="attributes" type={<a href="/docs/api-reference/v3/reference/catalog/attribute">[Attribute!]!</a>} required>
          The merchant-defined attributes set on this family.
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="description" type="String!" required>
          The product family's long-form description.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this product family.
        </ResponseField>

        <ResponseField name="image" type={<a href="/docs/api-reference/v3/reference/catalog/product-family-image">ProductFamilyImage</a>}>
          The first (default) image for this family, if any.

          **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
        </ResponseField>

        <ResponseField name="images" type={<a href="/docs/api-reference/v3/pagination">ProductFamilyImageConnection!</a>} required>
          A paginated list of the family's images.

          **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="options" type={<a href="/docs/api-reference/v3/reference/catalog/product-family-option">[ProductFamilyOption!]!</a>} required>
          The variant options (e.g. Size, Color) for this family.
        </ResponseField>

        <ResponseField name="products" type={<a href="/docs/api-reference/v3/pagination">ProductConnection!</a>} required>
          A paginated list of the products (variants) in this family.

          **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="tags" type="[String!]!" required>
          Free-form tags applied to the product family.
        </ResponseField>

        <ResponseField name="title" type="String!" required>
          The product family's title.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>

        <ResponseField name="vendor" type="String">
          The vendor or manufacturer of the product family.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="sku" type="String">
      The stock keeping unit identifying this product.
    </ResponseField>

    <ResponseField name="tags" type="[String!]!" required>
      Free-form tags applied to the product.
    </ResponseField>

    <ResponseField name="taxCode" type="String">
      The tax code used to classify the product for taxation.
    </ResponseField>

    <ResponseField name="taxable" type="Boolean!" required>
      Whether the product is subject to tax.
    </ResponseField>

    <ResponseField name="title" type="String!" required>
      The product's title.
    </ResponseField>

    <ResponseField name="upc" type="String">
      The Universal Product Code for this product.
    </ResponseField>

    <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was last updated.
    </ResponseField>

    <ResponseField name="vendor" type="String">
      The vendor or manufacturer of the product.
    </ResponseField>

    <ResponseField name="weight" type={<a href="/docs/api-reference/v3/reference/catalog/weight">Weight</a>}>
      The product's weight.

      <Expandable title="fields" lazyRender>
        <ResponseField name="unit" type={<a href="/docs/api-reference/v3/reference/catalog/weight-unit">WeightUnit!</a>} required>
          The unit the value is expressed in.
        </ResponseField>

        <ResponseField name="value" type="Float!" required>
          The numeric magnitude of the weight.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="referenceId" type="String">
  Opaque reference tying this entry to a source record (fulfillment, count session, etc.).
</ResponseField>

<ResponseField name="storageLocationName" type="String">
  Name of the bin or storage location for the linked inventory level today (not a snapshot at adjustment time).
</ResponseField>

<ResponseField name="userName" type="String">
  Display name of the user who performed the adjustment.
</ResponseField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.