Create Unit Group Associated Unit

Beta

POST/v1/catalog/unit-groups/{unit_group_id}/units

Idempotent with Idempotency-Key header. Learn more

Adds a unit to a unit group. If the unit is already in the group, its existing association is updated with the provided settings instead.

Permissions requiredValues:unit_groups:update

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

unit_group_idstring

Unit group ID.

include[]optional arrayenumValues:unit

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

unit_idstring

ID of the unit to associate with the group.

The unit's dimension must match the group's type.

discount_percentageoptional number

Percentage discount applied to the unit's price when an order is placed in this unit (e.g. 10 is a 10% discount). Defaults to 1.

discount_fixedoptional number

Flat amount subtracted from the unit's price when an order is placed in this unit. Defaults to 0.

customer_portal_visibilityoptional stringenumValues:visiblehidden

Whether the unit is shown to customers in the customer portal. Defaults to visible.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitunitExpandablenullable

The unit this association refers to.

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.

ownerownernullable

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.

discount_percentagenumber

Percentage discount applied to the unit's price when an order is placed in this unit (e.g. 10 is a 10% discount).

discount_fixednumber

Flat amount subtracted from the unit's price when an order is placed in this unit.

customer_portal_visibilitystringenumValues:visiblehidden

Whether this unit is shown to customers in the customer portal.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Unit Group Associated Unit

Create Unit Group Associated Unit

import Augno from '@augno/sdk';

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

const unitGroupUnit = await client.catalog.unitGroups.units.create(
  'ug_01aad07abb8e41fd392d2d7013',
  {
    unit_id: 'un_01966263f74a5a0cae356000a1',
    customer_portal_visibility: 'visible',
    discount_percentage: 1,
  },
);

console.log(unitGroupUnit.id);

import Augno from '@augno/sdk';

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

const unitGroupUnit = await client.catalog.unitGroups.units.create(
  'ug_01aad07abb8e41fd392d2d7013',
  {
    unit_id: 'un_01966263f74a5a0cae356000a1',
    customer_portal_visibility: 'visible',
    discount_percentage: 1,
  },
);

console.log(unitGroupUnit.id);

201 example

{
  "id": "ugu_01d75e0598ed09be56fd39fab5",
  "object": "unit_group_unit",
  "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"
  },
  "discount_percentage": 1,
  "discount_fixed": 0,
  "customer_portal_visibility": "visible",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ugu_01d75e0598ed09be56fd39fab5",
  "object": "unit_group_unit",
  "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"
  },
  "discount_percentage": 1,
  "discount_fixed": 0,
  "customer_portal_visibility": "visible",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Unit Group Associated Unit

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses