Create Unit Group

Beta

POST/v1/catalog/unit-groups

Idempotent with Idempotency-Key header. Learn more

Creates a unit group with optional associated units.

include[]optional arrayenumValues:ownerowner.accountbase_unit

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

namestring

Display name.

notesoptional string

Notes. Defaults to null.

typestringenumValues:currencyquantitytime

Unit type.

base_unit_idstring

Base unit ID.

associated_unitsoptional array of object

Associated units to create with the group.

unit_idstring

Unit ID.

discount_percentageoptional number

Discount percentage. Defaults to 1.

discount_fixedoptional number

Fixed discount amount. Defaults to 0.

customer_portal_visibilityoptional stringenumValues:visiblehidden

Customer portal visibility. Defaults to visible.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:currencyquantitytime

Unit type.

base_unitobjectExpandablenullable

Base unit.

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

Unit dimension.

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.

ownerobjectExpandablenullable

Owner of this resource.

Always returned as null in this endpoint.

created_atstring (date-time)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

associated_unitsobjectExpandablenullable

Associated units.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitobjectnullable

Unit.

Always returned as null in this endpoint.

discount_percentagenumber

Discount percentage.

discount_fixednumber

Fixed discount amount.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerobjectExpandablenullable

Owner.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Unit Group

Create Unit Group

import Augno from '@augno/sdk';

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

const unitGroup = await client.catalog.unitGroups.create({
  base_unit_id: 'un_01966263f74a5a0cae356000a1',
  name: 'Weight Units',
  type: 'mass',
  associated_units: [
    {
      unit_id: 'un_01966263f74a5a0cae356000a1',
      discount_percentage: 1,
      discount_fixed: 0,
      customer_portal_visibility: 'visible',
    },
  ],
});

console.log(unitGroup.id);

import Augno from '@augno/sdk';

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

const unitGroup = await client.catalog.unitGroups.create({
  base_unit_id: 'un_01966263f74a5a0cae356000a1',
  name: 'Weight Units',
  type: 'mass',
  associated_units: [
    {
      unit_id: 'un_01966263f74a5a0cae356000a1',
      discount_percentage: 1,
      discount_fixed: 0,
      customer_portal_visibility: 'visible',
    },
  ],
});

console.log(unitGroup.id);

201 example

{
  "id": "ug_01aad07abb8e41fd392d2d7013",
  "object": "unit_group",
  "name": "Weight",
  "type": "mass",
  "base_unit": {
    "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": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "owner": {
    "object": "owner",
    "type": "system"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ug_01aad07abb8e41fd392d2d7013",
  "object": "unit_group",
  "name": "Weight",
  "type": "mass",
  "base_unit": {
    "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": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "owner": {
    "object": "owner",
    "type": "system"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Unit Group

Query Parameters

Request Body

Returns

Responses