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

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query inventoryProperties {
6    inventoryProperties {
7      quantityNames {
8        belongsTo
9        comprises
10        displayName
11        isInUse
12        name
13      }
14    }
15  }`,
16);
17
18const data = await response.json();
19

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

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

1{
2  "inventoryProperties": {
3    "quantityNames": [
4      {
5        "belongsTo": [
6          "on_hand"
7        ],
8        "comprises": [],
9        "displayName": "Available",
10        "isInUse": true,
11        "name": "available"
12      },
13      {
14        "belongsTo": [
15          "on_hand"
16        ],
17        "comprises": [],
18        "displayName": "Committed",
19        "isInUse": true,
20        "name": "committed"
21      },
22      {
23        "belongsTo": [
24          "on_hand"
25        ],
26        "comprises": [],
27        "displayName": "Damaged",
28        "isInUse": false,
29        "name": "damaged"
30      },
31      {
32        "belongsTo": [],
33        "comprises": [],
34        "displayName": "Incoming",
35        "isInUse": true,
36        "name": "incoming"
37      },
38      {
39        "belongsTo": [],
40        "comprises": [
41          "available",
42          "committed",
43          "damaged",
44          "quality_control",
45          "reserved",
46          "safety_stock"
47        ],
48        "displayName": "On hand",
49        "isInUse": true,
50        "name": "on_hand"
51      },
52      {
53        "belongsTo": [
54          "on_hand"
55        ],
56        "comprises": [],
57        "displayName": "Quality control",
58        "isInUse": false,
59        "name": "quality_control"
60      },
61      {
62        "belongsTo": [
63          "on_hand"
64        ],
65        "comprises": [],
66        "displayName": "Reserved",
67        "isInUse": true,
68        "name": "reserved"
69      },
70      {
71        "belongsTo": [
72          "on_hand"
73        ],
74        "comprises": [],
75        "displayName": "Safety stock",
76        "isInUse": false,
77        "name": "safety_stock"
78      }
79    ]
80  }
81}