UnitOfMeasurement

This feature is currently under development and, although not available in the current version, its preliminary documentation is provided to give you a preview of the enhancements that will be included in an upcoming update.

HTTP Operation Type Object
Query unitOfMeasurements filtered by id Why?
Query unitOfMeasurements

Description

Represents the various units of measurement known as UnitsOfMeasurements in the API context and used for defining product quantities in the product interface.
These values are standardized to ensure consistency and accuracy across all calculations.
Each unit of measurement includes metadata such as Abbreviation, Number of Decimals, and Name, providing detailed descriptions for quantities.

The API resources overview / Unit of measurement Sales Setup parameter allows customization of these units within the product interface to define, for each unit, whether it will be used and, if so, for which Product Categories it applies.

img

Key Value
Authorization Bearer Current access Token How to find?
X-TenantId Current tenant id How to find?
x-api-key Primary or secondary subscription key of your app How to find?

unitOfMeasurements

Fields Type Description
id UUID Unique identifier of the unit of measurement.
numberOfDecimals Int Specifies the precision for quantities (e.g., the number of decimals allowed in sales documents).
name
  • NOT_UNIT
  • CUBIC_METRE
  • DAY
  • GRAM
  • HOUR
  • KILOGRAM
  • KILOMETRE
  • LITRE
  • METRE
  • MILLIGRAM
  • MILLILITRE
  • MONTH
  • NIGHT
  • PACK
  • PERCENTAGE
  • SQUARE_METRE
  • TONNE
  • UNIT
 Enumerated type for the name and abbreviation of the unit of measurement.
Info

  • Name - Abbreviations:
    As the API returns enumeration values but does not return their localized translations, unitOfMeasurements does not return the abbreviations, which, like the unit labels, are localizations of the enumerations.

    Below are the English abbreviations values for each unit:

    • NOT_UNIT:  
    • CUBIC_METRE:  m³
    • DAY:  DAYS
    • GRAM:  G
    • HOUR:  HR
    • KILOGRAM:  KG
    • KILOMETRE:  KM
    • LITRE:  L
    • METRE:  M
    • MILLIGRAM:  MG
    • MILLILITRE:  ML
    • MONTH:  MONTHS
    • NIGHT:  NIGHTS
    • PACK:  PACKS
    • PERCENTAGE:  %
    • SQUARE_METRE:  M²
    • TONNE:  T
    • UNIT:  UNITS