Anchor to section titled 'undefined'

inventoryProperties
query

Requires read_inventory access scope.

General inventory properties for the shop.

Anchor to section titled 'InventoryProperties possible returns'

InventoryProperties possible returns

Anchor to InventoryProperties
InventoryProperties
InventoryProperties
Access requirements

General inventory properties for the shop.

Was this section helpful?

Examples

Hide code
DescriptionCopy
query inventoryProperties {
  inventoryProperties {
    quantityNames {
      belongsTo
      comprises
      displayName
      isInUse
      name
    }
  }
}
Hide code
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"
      }
    ]
  }
}