Unit Groups

The unit_group object

A named collection of units that share one dimension, defining which units a product can be ordered in.

Each associated unit carries its own discount and customer portal visibility, applied when an order line is priced in that unit. A product takes its unit group from its product line, falling back to its item category.

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

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

Only units of this dimension can belong to the group, and the dimension is fixed once the group is created.

base_unitunitnullable

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

The dimension this 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)

Numerator of the ratio that converts a quantity in this unit into the dimension's base unit.

A quantity is converted with value × (ratio_numerator / ratio_denominator) + (offset_numerator / offset_denominator), so a kilogram in a gram-based dimension has a numerator of 1000 and a denominator of 1.

ratio_denominatorstring (decimal)

Denominator of the ratio that converts a quantity in this unit into the dimension's base unit.

Cannot be zero.

offset_numeratorstring (decimal)

Numerator of the conversion offset, applied after the ratio for scales that do not share a zero point, such as temperature.

Zero for units that convert by ratio alone.

offset_denominatorstring (decimal)

Denominator of the conversion offset applied after the ratio.

Never zero; a unit with no offset carries a numerator of 0 over a denominator of 1.

is_base_unitboolean

Whether this is the base unit for its dimension.

Every other unit's conversion ratio is expressed relative to the base unit. Base units are platform-defined; units created through the API are never base units.

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.

associated_unitslistnullable

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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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

Share of the unit's price removed when an order is placed in this unit.

Expressed as a decimal fraction rather than a whole number, so 0.1 is a 10% discount and 0 is no discount.

discount_fixednumber

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

Subtracted before discount_percentage is applied.

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.

ownerownernullable

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.

accountaccountnullable

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

The address billed by default on orders for this account.

Always returned as null in this endpoint.

default_shipping_addressaddressnullable

The address shipped to by default on orders for this account.

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.

Used by

POSTCreate Unit GroupUnit Groups PATCHUpdate Unit GroupUnit Groups GETList Unit GroupsUnit Groups GETRetrieve Unit GroupUnit Groups DELETEDelete Unit GroupUnit Groups POSTBulk Upsert Unit GroupsUnit Groups POSTCreate Unit Group Associated UnitUnit Groups PATCHUpdate Unit Group Associated UnitUnit Groups GETList Unit Group UnitsUnit Groups GETRetrieve Unit Group UnitUnit Groups DELETEDelete Unit Group Associated UnitUnit Groups POSTCreate Account PriceAccount Prices PATCHUpdate Account PriceAccount Prices GETList Account PricesAccount Prices GETRetrieve Account PriceAccount Prices GETList ItemsItems GETRetrieve ItemItems PUTAdd Item AttributeItems PUTChange Item CategoryItems DELETERemove Item AttributeItems POSTCreate Item CategoryItem Categories PATCHUpdate Item CategoryItem Categories GETList Item CategoriesItem Categories GETRetrieve Item CategoryItem Categories POSTCreate MaterialMaterials PATCHUpdate MaterialMaterials GETList MaterialsMaterials GETRetrieve MaterialMaterials DELETEDelete MaterialMaterials POSTCreate PartParts PATCHUpdate PartParts GETList PartsParts GETRetrieve PartParts DELETEDelete PartParts POSTCreate Product LineProduct Lines PATCHUpdate Product LineProduct Lines GETList Product LinesProduct Lines GETRetrieve Product LineProduct Lines POSTCreate ProductProducts PATCHUpdate ProductProducts GETList ProductsProducts GETRetrieve ProductProducts DELETEDelete ProductProducts PUTChange Product Product LineProducts POSTCreate Volume DiscountVolume Discounts PATCHUpdate Volume DiscountVolume Discounts GETList Volume DiscountsVolume Discounts GETRetrieve Volume DiscountVolume Discounts POSTQuote Sales Order PricesSales Orders PUTClose Sales OrderSales Orders PUTIssue Sales OrderSales Orders PUTReopen Sales OrderSales Orders PUTUnissue Sales OrderSales Orders

unit_group example

{
  "id": "ug_andst6m79n41",
  "object": "unit_group",
  "name": "Weight",
  "notes": "Mass units used for ordering raw materials by weight.",
  "type": "mass",
  "base_unit": {
    "id": "un_82bd37dae5po",
    "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"
  },
  "associated_units": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "ugu_sfrqqziz49dw",
        "object": "unit_group_unit",
        "unit": {
          "id": "un_82bd37dae5po",
          "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"
        },
        "discount_percentage": 1,
        "discount_fixed": 0,
        "customer_portal_visibility": "visible",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ug_andst6m79n41",
  "object": "unit_group",
  "name": "Weight",
  "notes": "Mass units used for ordering raw materials by weight.",
  "type": "mass",
  "base_unit": {
    "id": "un_82bd37dae5po",
    "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"
  },
  "associated_units": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "id": "ugu_sfrqqziz49dw",
        "object": "unit_group_unit",
        "unit": {
          "id": "un_82bd37dae5po",
          "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"
        },
        "discount_percentage": 1,
        "discount_fixed": 0,
        "customer_portal_visibility": "visible",
        "created_at": "2026-05-10T00:00:00Z",
        "updated_at": "2026-05-10T00:23:00Z"
      }
    ]
  },
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Unit Groups

Attributes

Used by