> ## Documentation Index
> Fetch the complete documentation index at: https://redo-44af351d-docs-v3-graphql-api-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# inventoryLevel
> Fetch a single inventory level by its id. List levels through `Product.inventoryLevels` or `Location.inventoryLevels`.
**Required scopes:**
[`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
## Arguments
The id of the inventory level to fetch.
## Returns
LocationInventoryLevel}>
Inventory levels for a product at a single location.
The quantity available to sell.
The quantity that can be built from components.
The quantity committed to existing orders.
DateTime!} required>
When the record was created.
The id of this inventory level.
InventoryProduct}>
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)
Barcodes associated with this product, for scanning.
Dimensions}>
The product's length, width, and height in a single shared unit, for box sizing.
The height, in `unit`.
The length, in `unit`.
DimensionUnit!} required>
The unit all three measurements are expressed in.
The width, in `unit`.
The Harmonized System code used for customs.
The id of this product.
ProductImage}>
The first (default) image for this product, if any.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
Alternative text describing the image.
Whether this is the default image.
The id of this image.
The image's ordering position.
The public URL of the image.
The country of origin, as a country code, for customs.
The stock keeping unit identifying this product.
The product's title.
The Universal Product Code for this product.
Weight}>
The product's weight, for shipping.
WeightUnit!} required>
The unit the value is expressed in.
The numeric magnitude of the weight.
Location}>
The location these inventory levels are held at.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
The city of the location's address.
The company name associated with the location.
The country code, e.g. "US".
DateTime!} required>
When the record was created.
The id of this location.
LocationInventoryLevelConnection!} required>
Per-product inventory levels held at this location.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[LocationInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[LocationInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
The location's display name.
The contact phone number for the location.
The postal or ZIP code, e.g. "84101".
The state or province code, e.g. "UT".
The first line of the street address.
The second line of the street address.
DateTime!} required>
When the record was last updated.
Product}>
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)
Attribute}>
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)
**Arguments**
The machine name of the attribute to look up.
**Fields**
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
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.
[Attribute!]!} required>
The merchant-defined attributes set on this product.
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
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.
Barcodes associated with this product.
Money}>
The merchant's unit cost for the product.
Decimal!} required>
The exact amount as a decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
DateTime!} required>
When the record was created.
The product's long-form description.
Dimensions}>
The product's length, width, and height, expressed in a single shared unit.
The height, in `unit`.
The length, in `unit`.
DimensionUnit!} required>
The unit all three measurements are expressed in.
The width, in `unit`.
The Harmonized System code used for customs.
The id of this product.
ProductImage}>
The first (default) image for this product, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
Alternative text describing the image.
Whether this is the default image.
The id of this image.
The image's ordering position.
The public URL of the image.
ProductImageConnection!} required>
A paginated list of the product's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[ProductImageEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[ProductImage!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
LocationInventoryLevel}>
This product's inventory level at a single location, if any.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
The id of the location to fetch the level at.
LocationInventoryLevelConnection!} required>
Per-location inventory levels for this product.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[LocationInventoryLevelEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[LocationInventoryLevel!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
[ProductOptionValue!]!} required>
The variant's selected option values (e.g. Size: M, Color: Red), ordered by the family's option positions.
The option name, e.g. Size.
The selected value, e.g. M.
The country of origin, as a country code.
Whether the product is a physical, shippable item.
Money}>
The product's selling price.
Decimal!} required>
The exact amount as a decimal string (e.g. "19.99").
ISO 4217 currency code (e.g. USD).
ProductFamily}>
The product family this product belongs to, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
Attribute}>
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)
**Arguments**
The machine name of the attribute to look up.
[Attribute!]!} required>
The merchant-defined attributes set on this family.
DateTime!} required>
When the record was created.
The product family's long-form description.
The id of this product family.
ProductFamilyImage}>
The first (default) image for this family, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
ProductFamilyImageConnection!} required>
A paginated list of the family's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
[ProductFamilyOption!]!} required>
The variant options (e.g. Size, Color) for this family.
ProductConnection!} required>
A paginated list of the products (variants) in this family.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
Free-form tags applied to the product family.
The product family's title.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product family.
The stock keeping unit identifying this product.
Free-form tags applied to the product.
The tax code used to classify the product for taxation.
Whether the product is subject to tax.
The product's title.
The Universal Product Code for this product.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product.
Weight}>
The product's weight.
WeightUnit!} required>
The unit the value is expressed in.
The numeric magnitude of the weight.
The total quantity on hand at the location.
The quantity reserved across all reservation buckets.
DateTime!} required>
When the record was last updated.
## Example
```graphql theme={null}
query {
inventoryLevel(id: "...") {
available
buildable
committed
createdAt
id
quantity
reserved
updatedAt
}
}
```