Skip to main content
POST
Create unit conversion rule

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
type
enum<string>
required
Available options:
SYSTEM,
SKU
base_unit_of_measure_id
integer
required
converted_unit_of_measure_id
integer
required
conversion_factor
number
required
Required range: x > 0
product_id
integer

Required when type=SKU; omit when type=SYSTEM.

Response

Created

data
object

A rule converting from one unit of measure to another. type=SYSTEM rules apply globally for a class (e.g. 1 lb = 0.453592 kg). type=SKU rules override system rules for a specific product (product_id).