Skip to main content

ProductInventory

No description

type ProductInventory {
  productId: Int!
  totalQuantity: Int!
  totalReservedQuantity: Int!
  supplierQuantity: Int!
  supplierReservedQuantity: Int!
  localQuantity: Int!
  localReservedQuantity: Int!
  totalAllocatedQuantity: Int
  localAllocatedQuantity: Int
  supplierAllocatedQuantity: Int
  totalExpectedQuantity: Int
  localExpectedQuantity: Int
  supplierExpectedQuantity: Int
  totalFreeQuantity: Int
  localFreeQuantity: Int
  supplierFreeQuantity: Int
  totalEconomicQuantity: Int
  localEconomicQuantity: Int
  supplierEconomicQuantity: Int
  nextDeliveryDate: DateTime
  nextExpectedDeliveryDate: DateTime
  balance: [Inventory!]
  messages: [String!] @deprecated
  total: Int!
}

Fields​

ProductInventory.productId ● Int! non-null scalar​

Product identifier for this inventory summary.

References the specific product that this inventory aggregation represents, linking to the product catalog.

ProductInventory.totalQuantity ● Int! non-null scalar​

Total non-reserved quantity available across all locations.

Sum of all inventory quantities for this product across all warehouses and locations.

ProductInventory.totalReservedQuantity ● Int! non-null scalar​

Total quantity reserved across all locations.

Sum of all reserved quantities for this product across all warehouses and locations.

ProductInventory.supplierQuantity ● Int! non-null scalar​

Non-reserved quantity available from external suppliers.

Stock quantity that can be sourced from suppliers, including drop-ship inventory and supplier-managed stock.

ProductInventory.supplierReservedQuantity ● Int! non-null scalar​

Total quantity reserved from external suppliers.

Sum of all reserved quantities for this product from external suppliers.

ProductInventory.localQuantity ● Int! non-null scalar​

Non-reserved quantity available in local warehouses.

Stock quantity physically held in company-owned warehouses and storage facilities, immediately available for fulfillment.

ProductInventory.localReservedQuantity ● Int! non-null scalar​

Total quantity reserved in local warehouses.

Sum of all reserved quantities for this product in company-owned warehouses and storage facilities.

ProductInventory.totalAllocatedQuantity ● Int scalar​

Total allocated quantity across all locations.

Sum of allocatedQuantity over the non company-specific rows that carry a value; rows where it is null are skipped, not treated as 0. Null only when no contributing row has a value.

ProductInventory.localAllocatedQuantity ● Int scalar​

Allocated quantity in local warehouses.

The totalAllocatedQuantity restricted to locally managed stock.

ProductInventory.supplierAllocatedQuantity ● Int scalar​

Allocated quantity from external suppliers.

The totalAllocatedQuantity restricted to supplier-managed stock.

ProductInventory.totalExpectedQuantity ● Int scalar​

Total expected quantity across all locations.

Sum of expectedQuantity — stock purchased from a supplier but not yet received — over the non company-specific rows that carry a value. Rows where it is null are skipped, not treated as 0. Null only when no contributing row has a value.

ProductInventory.localExpectedQuantity ● Int scalar​

Expected quantity for local warehouses.

The totalExpectedQuantity restricted to locally managed stock.

ProductInventory.supplierExpectedQuantity ● Int scalar​

Expected quantity from external suppliers.

The totalExpectedQuantity restricted to supplier-managed stock.

ProductInventory.totalFreeQuantity ● Int scalar​

Total quantity that can still be promised.

Sum of the per-record freeQuantity (quantity - allocatedQuantity) over the non company-specific rows where it is not null. A row without an allocatedQuantity contributes nothing at all — not even its quantity — so this does NOT equal totalQuantity - totalAllocatedQuantity when only some rows are synced. Null only when no contributing row has a value; may be negative, which is a genuine oversell signal.

ProductInventory.localFreeQuantity ● Int scalar​

Quantity that can still be promised from local warehouses.

The totalFreeQuantity restricted to locally managed stock.

ProductInventory.supplierFreeQuantity ● Int scalar​

Quantity that can still be promised from external suppliers.

The totalFreeQuantity restricted to supplier-managed stock.

ProductInventory.totalEconomicQuantity ● Int scalar​

Total quantity carrying price risk.

Sum of the per-record economicQuantity (quantity - allocatedQuantity + expectedQuantity) over the non company-specific rows where it is not null. A record contributes only when BOTH allocatedQuantity and expectedQuantity are known. Null only when no contributing row has a value.

ProductInventory.localEconomicQuantity ● Int scalar​

Quantity carrying price risk in local warehouses.

The totalEconomicQuantity restricted to locally managed stock.

ProductInventory.supplierEconomicQuantity ● Int scalar​

Quantity carrying price risk from external suppliers.

The totalEconomicQuantity restricted to supplier-managed stock.

ProductInventory.nextDeliveryDate ● DateTime scalar​

Earliest expected delivery date for replenishment.

The soonest date when additional inventory is expected to arrive, used for stock planning and customer communication about future availability.

ProductInventory.nextExpectedDeliveryDate ● DateTime scalar​

Earliest expected delivery date for stock that is actually incoming.

The soonest nextDeliveryDate among the non company-specific records that report an expectedQuantity greater than 0 — the date attached to stock that has been purchased and is on its way. Null when no such record exists. Differs from nextDeliveryDate on two counts: that one is the minimum over every dated record regardless of whether anything is incoming, and it includes company-specific records, which this field excludes to stay consistent with totalExpectedQuantity.

ProductInventory.balance ● [Inventory!] list object​

Detailed inventory records for this product.

Complete list of individual inventory entries showing stock levels, locations, suppliers, and costs for comprehensive inventory management.

ProductInventory.total ● Int! non-null scalar​

Total count or summary value for the operation.

Show deprecated

Member Of​

Product object