Skip to main content

UomChangePreview

What changing a product's unit of measure would do to its stock.

type UomChangePreview {
  after: QuantityValue
  allowed: Boolean!
  before: QuantityValue!
  locations: [UomChangeLocation!]!
  reason: String
  restockThresholdAfter: QuantityValue
  restockThresholdBefore: QuantityValue
}

Fields​

UomChangePreview.after ● QuantityValue object inventory​

The same stock in the new unit of measure. Null when the change is not allowed.

UomChangePreview.allowed ● Boolean! non-null scalar common​

True when updateProduct would accept the new unit of measure.

UomChangePreview.before ● QuantityValue! non-null object inventory​

The product's stock across all locations, in its current unit of measure.

UomChangePreview.locations ● [UomChangeLocation!]! non-null object products​

Each location with stock, before and after the change.

UomChangePreview.reason ● String scalar common​

Why the change is not allowed. Null when it is allowed.

UomChangePreview.restockThresholdAfter ● QuantityValue object inventory​

The restock threshold after the change: 0 when the new unit stores stock in a different unit, otherwise the same threshold in the new unit. Null when no threshold is set or the change is not allowed.

UomChangePreview.restockThresholdBefore ● QuantityValue object inventory​

The product's restock threshold in its current unit of measure. Null when no threshold is set.

Returned By​

productUomChangePreview query