Create Unit

Beta

POST/v1/catalog/units

Idempotent with Idempotency-Key header. Learn more

Creates an account-owned unit.

Permissions requiredValues:units:create

The role behind your API key or agent must grant every one of these permissions.

include[]optional arrayenumValues:ownerowner.account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name of the unit (e.g. "Gram").

Must be unique within the account.

abbreviationstring

Short abbreviation for the unit (e.g. "g").

Must be unique within the account.

typestringenumValues:currencyquantitytime

Unit dimension.

Units can only be converted to other units of the same dimension.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit.

Must not be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

offset_denominatorstring (decimal)

Conversion offset denominator.

Must not be zero.

idstring

Unit ID.

objectstringenumValues:unit

Resource type identifier.

namestring

Display name of the unit (e.g. "Gram", "Kilogram").

abbreviationstring

Short abbreviation for the unit (e.g. "g", "kg").

typestringenumValues:currencyquantitytime

Physical dimension the unit measures, such as mass, volume, or currency.

A unit can only be converted to another unit of the same dimension. The quantity dimension is for discrete countable items rather than a physical measure.

ratio_numeratorstring (decimal)

Conversion ratio numerator relative to the base unit in the same dimension.

ratio_denominatorstring (decimal)

Conversion ratio denominator relative to the base unit in the same dimension.

Cannot be zero.

offset_numeratorstring (decimal)

Conversion offset numerator, used for temperature-like conversions.

Zero for most unit types.

offset_denominatorstring (decimal)

Conversion offset denominator.

Typically 1. Cannot be zero.

is_base_unitboolean

Whether this is the base unit for its dimension.

Conversion ratios are relative to this unit. Base units are platform-defined; account-created units always have this set to false.

ownerownerExpandablenullable

Owner of this resource.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

Where this resource came from.

system: a platform-provided default shared across all accounts; not editable.
account: created and owned by a specific account; the account field identifies which.

accountaccountExpandablenullable

The account that owns this resource.

Present only when type is account; system-owned resources have no owning account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.

brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.

portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

Responses

201

Successful response for Create Unit

Create Unit

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const unit = await client.catalog.units.create({
  abbreviation: 'g',
  name: 'Gram',
  offset_denominator: '1',
  offset_numerator: '0',
  ratio_denominator: '1',
  ratio_numerator: '1',
  type: 'mass',
});

console.log(unit.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const unit = await client.catalog.units.create({
  abbreviation: 'g',
  name: 'Gram',
  offset_denominator: '1',
  offset_numerator: '0',
  ratio_denominator: '1',
  ratio_numerator: '1',
  type: 'mass',
});

console.log(unit.id);

201 example

{
  "id": "un_01966263f74a5a0cae356000a1",
  "object": "unit",
  "name": "Kilogram",
  "abbreviation": "kg",
  "type": "mass",
  "ratio_numerator": "1000",
  "ratio_denominator": "1",
  "offset_numerator": "0",
  "offset_denominator": "1",
  "is_base_unit": false,
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "un_01966263f74a5a0cae356000a1",
  "object": "unit",
  "name": "Kilogram",
  "abbreviation": "kg",
  "type": "mass",
  "ratio_numerator": "1000",
  "ratio_denominator": "1",
  "offset_numerator": "0",
  "offset_denominator": "1",
  "is_base_unit": false,
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Unit

Authorization

Query Parameters

Request Body

Returns

Responses