inventoryProperties

query

Requires read_inventory access scope.

General inventory properties for the shop.

Anchor to Possible returnsPossible returns

Anchor to InventoryPropertiesInventoryProperties • InventoryProperties!: General inventory properties for the shop.

Was this section helpful?

Get inventory properties for a shop
Get inventory quantity names to be used with inventory queries and mutations

Examples

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

const response = await admin.graphql(

`#graphql

query inventoryProperties {

inventoryProperties {

quantityNames {

belongsTo

comprises

displayName

isInUse

name

}

}`,

);

const data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-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 } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query inventoryProperties {
    inventoryProperties {
      quantityNames {
        belongsTo
        comprises
        displayName
        isInUse
        name
      }
    }
  }`,
);

const data = await response.json();

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

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": [],