UOM's

UOM's

The UOM is short for Unit Of Measure. This is the unit in which a product can be sold. (E.g. 6 pieces per box)

In the Cloudsuite admin the uom’s can be found under PIM / Eenheden

URL

POST /api/uom/ PUT  /api/uom/{key}

The UOM has no origin.

 

Fields

Fields

Mandatory

Description

Remarks

 

Fields

Mandatory

Description

Remarks

 

key

yes

The key of the UOM

Must be unique.

 

name

yes

The full name of the UOM

 

 

category

yes

To which category this UOM belongs. Most UOM's are set in the category “Units“ (key = “u“ or “units“)

The category must exist in the CloudSuite database. This setting is a fixed list.

 

digits

yes

The number of digits for the value of this UOM

 

 

rounding

yes

Precision of the decimal values

 

 

rate

yes

1.0

Mostly 1.0 but it can be something else when working when different sale uom’s, see different scenario’s

 

factor

yes

1.0

Mostly 1.0 but it can be something else when working when working with different sale uom’s, see different scenario’s

 

symbol

yes

The short name for this UOM

For example: name can be “kilogram” and symbol “kg“.

 

active

no

Indicates whether the UOM is active or not

Use true or false.

 

uom_contents

no

Array of objects (UoMContent)

This field will only be effective if your contract covers the cloudsuite_price_unity module

 

 

Example

 

Related content

© 2024 CloudSuite BV, All rights reserved