Skip to main content

ProductUOM

A unit (pack) set up on a product or variant: its conversion factor to the base unit, the documents it can be used on, and its ordering and pricing rules.

type ProductUOM {
  barcode: String
  conversionFactor: Float!
  createdAt: DateTime!
  deletedAt: DateTime
  deletedBy: String
  enteredBy: String!
  gtin: String
  height: Float
  id: ID!
  isBase: Boolean!
  isInventory: Boolean!
  isPurchase: Boolean!
  isSales: Boolean!
  length: Float
  listPrice: Float
  maxOrderQty: Float
  minOrderQty: Float!
  orderMultiple: Float!
  productId: String!
  salePrice: Float
  standardCost: Float
  uom: UnitOfMeasure!
  uomId: String!
  updatedAt: DateTime!
  updatedBy: String!
  variantId: String
  weight: Float
  width: Float
}

Fields

`ProductUOM.barcode` ● `String` scalar

Barcode of this pack.

`ProductUOM.conversionFactor` ● `Float!` non-null scalar

How many base units one of this unit contains. The base unit is 1.

`ProductUOM.createdAt` ● `DateTime!` non-null scalar

When the record was created.

`ProductUOM.deletedAt` ● `DateTime` scalar

When the record was deleted. Empty while the record is live.

`ProductUOM.deletedBy` ● `String` scalar

The ID of the user who deleted the record.

`ProductUOM.enteredBy` ● `String!` non-null scalar

The ID of the user who created the record.

`ProductUOM.gtin` ● `String` scalar

Global Trade Item Number (GTIN) of this pack.

`ProductUOM.height` ● `Float` scalar

Height of one of this unit.

`ProductUOM.id` ● `ID!` non-null scalar

The unique ID of this record.

`ProductUOM.isBase` ● `Boolean!` non-null scalar

Whether this is the product's base unit.

`ProductUOM.isInventory` ● `Boolean!` non-null scalar

Whether stock is held in this unit.

`ProductUOM.isPurchase` ● `Boolean!` non-null scalar

Whether the unit can be used on purchase documents.

`ProductUOM.isSales` ● `Boolean!` non-null scalar

Whether the unit can be used on sales documents. A variant can have at most 3 sellable units.

`ProductUOM.length` ● `Float` scalar

Length of one of this unit.

`ProductUOM.listPrice` ● `Float` scalar

List price of one of this unit.

`ProductUOM.maxOrderQty` ● `Float` scalar

Largest quantity of this unit that can be ordered.

`ProductUOM.minOrderQty` ● `Float!` non-null scalar

Smallest quantity of this unit that can be ordered.

`ProductUOM.orderMultiple` ● `Float!` non-null scalar

Quantities of this unit are ordered in multiples of this.

`ProductUOM.productId` ● `String!` non-null scalar

The ID of the product the unit is set up on.

`ProductUOM.salePrice` ● `Float` scalar

Sale price of one of this unit.

`ProductUOM.standardCost` ● `Float` scalar

Standard cost of one of this unit.

`ProductUOM.uom` ● `UnitOfMeasure!` non-null object

The unit of measure.

`ProductUOM.uomId` ● `String!` non-null scalar

The ID of the unit of measure.

`ProductUOM.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`ProductUOM.updatedBy` ● `String!` non-null scalar

The ID of the user who last changed the record.

`ProductUOM.variantId` ● `String` scalar

The ID of the variant the unit is set up on. Empty for a product-wide unit.

`ProductUOM.weight` ● `Float` scalar

Weight of one of this unit.

`ProductUOM.width` ● `Float` scalar

Width of one of this unit.

Returned By

addProductUOM mutation ● getProductUOM query ● getProductUOMs query

Fields
Returned By