Update Unit Group

Beta

PATCH/v1/catalog/unit-groups/{id}

Idempotent with Idempotency-Key header. Learn more

Partially updates a unit group. System unit groups cannot be updated.

Permissions requiredValues:unit_groups:update

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

idstring

Unit group ID.

include[]optional arrayenumValues:ownerowner.accountbase_unit

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

nameoptional string

Display name of the unit group.

Must be unique within the account.

notesoptional stringnullable

Free-form notes about the unit group.

Set to null to clear. Send null to clear.

base_unit_idoptional string

ID of the group's base unit.

associated_unitsoptional array of object

Associated units to add or update in the group.

Upserted by unit: a listed unit already in the group has its association updated, otherwise it is added. Existing units not in the list are preserved.

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 ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name of the unit group.

Unique within the account.

notesstringnullable

Free-form notes about the unit group.

typestringenumValues:currencyquantitytime

Physical dimension shared by every unit in this group, such as mass, volume, or currency.

Only units of this dimension can belong to the group.

base_unitunitExpandablenullable

The reference unit designated for this group.

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.

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_unitslistExpandablenullable

Units associated with this group, each with its own discount and customer portal visibility settings.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while 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 unit_group_unit

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitunitnullable

The unit this association refers to.

Always returned as null in this endpoint.

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.

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)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Update Unit Group

Update 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.update('ug_01aad07abb8e41fd392d2d7013', {
  base_unit_id: 'un_01966263f74a5a0cae356000a1',
  name: 'Weight Units (Updated)',
});

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.update('ug_01aad07abb8e41fd392d2d7013', {
  base_unit_id: 'un_01966263f74a5a0cae356000a1',
  name: 'Weight Units (Updated)',
});

console.log(unitGroup.id);

200 example

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

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

Update Unit Group

Authorization

Path Parameters

Query Parameters

Request Body

Returns

Responses