Skip to main content
POST
/
unit-of-measures
Create unit of measure
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/unit-of-measures \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "unit_class_id": 123,
  "name": "<string>",
  "description": "<string>",
  "base_unit": true,
  "conversion_factor": 1
}
'
{
  "data": {
    "id": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "status": "<string>",
    "unit_class_id": 123,
    "unit_class": {
      "id": 123,
      "name": "<string>",
      "base_class": true
    },
    "name": "<string>",
    "description": "<string>",
    "base_unit": true,
    "unit_conversion_rules": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "base_unit_of_measure_id": 123,
        "base_unit_of_measure": {
          "id": 123,
          "name": "<string>",
          "unit_class_id": 123,
          "base_unit": true
        },
        "converted_unit_of_measure_id": 123,
        "converted_unit_of_measure": {
          "id": 123,
          "name": "<string>",
          "unit_class_id": 123,
          "base_unit": true
        },
        "conversion_factor": 123,
        "type": "SYSTEM",
        "product_id": 123,
        "product": {},
        "product_alternate_skus": [
          {}
        ]
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
unit_class_id
integer
required
​
name
string
required
​
description
string
required
​
base_unit
boolean

When true, this UOM becomes the base unit for its class.

​
conversion_factor
number

Optional. When provided alongside a non-base UOM, a SYSTEM conversion rule from the base UOM to this new UOM is created automatically with the given factor.

Required range: x >= 0

Response

Created

​
data
object

A single unit of measure (e.g. "Pound", "Kilogram") belonging to a unit class.