Skip to main content

UpdateUOMInput

Changes to a unit of measure. Only the fields you send change.

input UpdateUOMInput {
allowFractional: Boolean
colorCode: String
compoundWithUOMId: String
decimalPlaces: Int
description: String
displayOrder: Int
iconUrl: String
isActive: Boolean
name: String
pluralName: String
symbol: String
}

Fields​

UpdateUOMInput.allowFractional ● Boolean scalar​

Whether quantities in this unit may be fractional. Must be false for a COUNT unit.

UpdateUOMInput.colorCode ● String scalar​

Colour code used to show the unit.

UpdateUOMInput.compoundWithUOMId ● String scalar​

The ID of the unit this unit combines with in compound quantities.

UpdateUOMInput.decimalPlaces ● Int scalar​

How many decimal places quantities in this unit show, from 0 to 6. Must be 0 for a COUNT unit.

UpdateUOMInput.description ● String scalar​

Free-text description of the unit.

UpdateUOMInput.displayOrder ● Int scalar​

Position of the unit in lists. Lower numbers come first.

UpdateUOMInput.iconUrl ● String scalar​

URL of the unit's icon image.

UpdateUOMInput.isActive ● Boolean scalar​

Set to false to deactivate the unit. The organization's default unit and the base unit of a product cannot be deactivated.

UpdateUOMInput.name ● String scalar​

The unit's name. At most 100 characters.

UpdateUOMInput.pluralName ● String scalar​

Plural form of the name, when it needs one.

UpdateUOMInput.symbol ● String scalar​

Symbol shown next to quantities in this unit. At most 20 characters.

Member Of​

updateUOM mutation