data-src=../../../../includes/saas-only.md

sourceAvailability query

Use the sourceAvailability query to check per-source inventory availability for one or more SKUs. The query reports availability only for the storefront-visible inventory sources that are enabled and assigned to the current sales channel's stock, so a storefront read never discloses a source the merchant has not opted in and never disagrees with what checkout allows.

Availability is gated at two levels, and both are off by default because they disclose which sources stock a SKU:

• Store level. Go to Stores > Configuration > Catalog > Inventory > Per-Source Availability (Storefront) and set Enable sourceAvailability GraphQL Query to Yes. While this setting is off, the query returns an error.

• Source level. Each inventory source has a Visible on Storefront flag that is off by default. A source's stock is never returned until a merchant enables it. To set it, go to Stores > Inventory > Sources, edit a source, and turn on Visible on Storefront.

The exact available_qty value is returned only when it is at or below the store's Only X left Threshold setting. Above the threshold, available_qty is null and is_in_stock is the only reliable signal. This threshold defaults to 0, so by default every positive quantity is masked and is_in_stock is the authoritative field to check. To change it, go to Stores > Configuration > Catalog > Inventory > Stock Options and set Only X left Threshold.

Syntax

sourceAvailability (skus: [String!]! source_codes: [String!] only_in_stock: Boolean): [SkuSourceAvailability!]!

The query accepts the following arguments:

Reference

The sourceAvailability reference provides detailed information about the types and fields defined in this query.

Example usage

The following query checks availability for a single SKU at two named sources.

Request:

{
  sourceAvailability(
    skus: ["24-MB01"]
    source_codes: ["default", "east-warehouse"]
    only_in_stock: false
  ) {
    sku
    sources {
      source_code
      sku
      available_qty
      is_in_stock
    }
  }
}

Response:

{
  "data": {
    "sourceAvailability": [
      {
        "sku": "24-MB01",
        "sources": [
          {
            "source_code": "default",
            "sku": "24-MB01",
            "available_qty": null,
            "is_in_stock": true
          },
          {
            "source_code": "east-warehouse",
            "sku": "24-MB01",
            "available_qty": 0,
            "is_in_stock": false
          }
        ]
      }
    ]
  }
}

Errors