Choose a version:

inventoryProperties

query

Requires read_inventory access scope.

Returns the shop's inventory configuration, including all inventory quantity names. Quantity names represent different inventory states that merchants use to track inventory.

Anchor to Possible returnsPossible returns

Anchor to InventoryPropertiesInventoryProperties

•InventoryProperties!

General inventory properties for the shop.

Anchor to quantityNamesquantityNames •[InventoryQuantityName!]! non-null: All the quantity names.

Was this section helpful?

Examples

Get inventory properties for a shop

Description

Retrieve the details of inventoryProperties.

Query

query inventoryProperties {
  inventoryProperties {
    quantityNames {
      belongsTo
      comprises
      displayName
      isInUse
      name
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryProperties { inventoryProperties { quantityNames { belongsTo comprises displayName isInUse name } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query inventoryProperties {
    inventoryProperties {
      quantityNames {
        belongsTo
        comprises
        displayName
        isInUse
        name
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query inventoryProperties {
    inventoryProperties {
      quantityNames {
        belongsTo
        comprises
        displayName
        isInUse
        name
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query inventoryProperties {
    inventoryProperties {
      quantityNames {
        belongsTo
        comprises
        displayName
        isInUse
        name
      }
    }
  }`,
});

Response

{
  "inventoryProperties": {
    "quantityNames": [
      {
        "belongsTo": [
          "on_hand"
        ],
        "comprises": [],
        "displayName": "Available",
        "isInUse": true,
        "name": "available"
      },
      {
        "belongsTo": [
          "on_hand"
        ],
        "comprises": [],
        "displayName": "Committed",
        "isInUse": true,
        "name": "committed"
      },
      {
        "belongsTo": [
          "on_hand"
        ],
        "comprises": [],
        "displayName": "Damaged",
        "isInUse": false,
        "name": "damaged"
      },
      {
        "belongsTo": [],
        "comprises": [],
        "displayName": "Incoming",
        "isInUse": true,
        "name": "incoming"
      },
      {
        "belongsTo": [],
        "comprises": [
          "available",
          "committed",
          "damaged",
          "quality_control",
          "reserved",
          "safety_stock"
        ],
        "displayName": "On hand",
        "isInUse": true,
        "name": "on_hand"
      },
      {
        "belongsTo": [
          "on_hand"
        ],
        "comprises": [],
        "displayName": "Quality control",
        "isInUse": false,
        "name": "quality_control"
      },
      {
        "belongsTo": [
          "on_hand"
        ],
        "comprises": [],
        "displayName": "Reserved",
        "isInUse": true,
        "name": "reserved"
      },
      {
        "belongsTo": [
          "on_hand"
        ],
        "comprises": [],
        "displayName": "Safety stock",
        "isInUse": false,
        "name": "safety_stock"
      }
    ]
  }
}

Get inventory quantity names to be used with inventory queries and mutations

Description

Retrieve the details of inventoryProperties.

Query

query inventoryProperties {
  inventoryProperties {
    quantityNames {
      name
      isInUse
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryProperties { inventoryProperties { quantityNames { name isInUse } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query inventoryProperties {
    inventoryProperties {
      quantityNames {
        name
        isInUse
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query inventoryProperties {
    inventoryProperties {
      quantityNames {
        name
        isInUse
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query inventoryProperties {
    inventoryProperties {
      quantityNames {
        name
        isInUse
      }
    }
  }`,
});

Response

{
  "inventoryProperties": {
    "quantityNames": [
      {
        "name": "available",
        "isInUse": true
      },
      {
        "name": "committed",
        "isInUse": true
      },
      {
        "name": "damaged",
        "isInUse": false
      },
      {
        "name": "incoming",
        "isInUse": true
      },
      {
        "name": "on_hand",
        "isInUse": true
      },
      {
        "name": "quality_control",
        "isInUse": false
      },
      {
        "name": "reserved",
        "isInUse": true
      },
      {
        "name": "safety_stock",
        "isInUse": false
      }
    ]
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query inventoryProperties {

inventoryProperties {

quantityNames {

belongsTo

comprises

displayName

isInUse

name

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query inventoryProperties {
  inventoryProperties {
    quantityNames {
      belongsTo
      comprises
      displayName
      isInUse
      name
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryProperties { inventoryProperties { quantityNames { belongsTo comprises displayName isInUse name } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query inventoryProperties {
    inventoryProperties {
      quantityNames {
        belongsTo
        comprises
        displayName
        isInUse
        name
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query inventoryProperties {
    inventoryProperties {
      quantityNames {
        belongsTo
        comprises
        displayName
        isInUse
        name
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query inventoryProperties {
    inventoryProperties {
      quantityNames {
        belongsTo
        comprises
        displayName
        isInUse
        name
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"inventoryProperties": {

"quantityNames": [

{

"belongsTo": [

"on_hand"

"comprises": [],

"displayName": "Available",

"isInUse": true,

"name": "available"

{

"belongsTo": [

"on_hand"

"comprises": [],

"displayName": "Committed",

"isInUse": true,

"name": "committed"

{

"belongsTo": [

"on_hand"

"comprises": [],

"displayName": "Damaged",

"isInUse": false,

"name": "damaged"

{

"belongsTo": [],

"comprises": [],

"displayName": "Incoming",

"isInUse": true,

"name": "incoming"

{

"belongsTo": [],

"comprises": [

"available",

"committed",

"damaged",

"quality_control",

"reserved",

"safety_stock"

"displayName": "On hand",

"isInUse": true,

"name": "on_hand"

{

"belongsTo": [

"on_hand"

"comprises": [],

"displayName": "Quality control",

"isInUse": false,

"name": "quality_control"

{

"belongsTo": [

"on_hand"

"comprises": [],

"displayName": "Reserved",

"isInUse": true,

"name": "reserved"

{

"belongsTo": [

"on_hand"

"comprises": [],

"displayName": "Safety stock",

"isInUse": false,

"name": "safety_stock"

}

]

}