Anchor to section titled 'undefined'inventory
inventory
query
2024-07
Requires read access scope.
General inventory properties for the shop.
Anchor to section titled 'InventoryProperties possible returns'
InventoryProperties possible returns
General inventory properties for the shop.
Was this section helpful?
Code examples for QUERY: inventoryProperties
Query Reference for QUERY: inventoryProperties
"{\n inventoryProperties {\n # InventoryProperties fields\n }\n}"Input Reference for QUERY: inventoryProperties
Schema Reference for QUERY: inventoryProperties
Display Examples for QUERY: inventoryProperties
[
{
"example": {
"type_name": "inventoryproperties",
"title": "Get inventory properties for a shop",
"description": "Retrieve the details of inventoryProperties.",
"query_string": "query inventoryProperties {\n inventoryProperties {\n quantityNames {\n belongsTo\n comprises\n displayName\n isInUse\n name\n }\n }\n}",
"response": {
"data": {
"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"
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/inventory_properties_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query inventoryProperties { inventoryProperties { quantityNames { belongsTo comprises displayName isInUse name } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query inventoryProperties {\n inventoryProperties {\n quantityNames {\n belongsTo\n comprises\n displayName\n isInUse\n name\n }\n }\n }`,\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query inventoryProperties {\n inventoryProperties {\n quantityNames {\n belongsTo\n comprises\n displayName\n isInUse\n name\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query inventoryProperties {\n inventoryProperties {\n quantityNames {\n belongsTo\n comprises\n displayName\n isInUse\n name\n }\n }\n }`,\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n query inventoryProperties {\n inventoryProperties {\n quantityNames {\n belongsTo\n comprises\n displayName\n isInUse\n name\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
},
{
"example": {
"type_name": "inventoryproperties",
"title": "Get inventory quantity names to be used with inventory queries and mutations",
"description": "Retrieve the details of inventoryProperties.",
"query_string": "query inventoryProperties {\n inventoryProperties {\n quantityNames {\n name\n isInUse\n }\n }\n}",
"response": {
"data": {
"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
}
]
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/inventory_properties_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query inventoryProperties { inventoryProperties { quantityNames { name isInUse } } }\"\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query inventoryProperties {\n inventoryProperties {\n quantityNames {\n name\n isInUse\n }\n }\n }`,\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n query inventoryProperties {\n inventoryProperties {\n quantityNames {\n name\n isInUse\n }\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query inventoryProperties {\n inventoryProperties {\n quantityNames {\n name\n isInUse\n }\n }\n }`,\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n query inventoryProperties {\n inventoryProperties {\n quantityNames {\n name\n isInUse\n }\n }\n }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
},
"titleStringKey": "arguments",
"inputVariableEntries": []
}
]