Units

The unit object

Unit of measurement used for conversions and product quantities.

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.

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)

When this unit was created.

updated_atstring (date-time)

When this unit was last updated.

Used by

POSTCreate UnitUnits PATCHUpdate UnitUnits GETList UnitsUnits GETRetrieve UnitUnits DELETEDelete UnitUnits POSTBulk Upsert UnitsUnits POSTCreate Unit GroupUnit Groups PATCHUpdate Unit GroupUnit Groups GETList Unit GroupsUnit Groups GETRetrieve Unit GroupUnit Groups POSTCreate Unit Group Associated UnitUnit Groups PATCHUpdate Unit Group Associated UnitUnit Groups GETList Unit Group UnitsUnit Groups GETRetrieve Unit Group UnitUnit Groups POSTCreate Account PriceAccount Prices PATCHUpdate Account PriceAccount Prices GETList Account PricesAccount Prices GETRetrieve Account PriceAccount Prices POSTCreate Shipping TermShipping Terms PATCHUpdate Shipping TermShipping Terms GETList Shipping TermsShipping Terms GETRetrieve Shipping TermShipping Terms POSTCreate Sales TargetSales Targets PUTUpsert Sales TargetSales Targets GETList Sales TargetsSales Targets GETList ItemsItems GETRetrieve ItemItems PUTAdd Item AttributeItems PUTChange Item CategoryItems GETRetrieve Item InventoryItems GETRetrieve Item Lot DefaultItems 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 DepartmentDepartments PATCHUpdate DepartmentDepartments GETList DepartmentsDepartments GETRetrieve DepartmentDepartments POSTCreate CustomerCustomers PATCHUpdate CustomerCustomers GETList CustomersCustomers GETRetrieve CustomerCustomers POSTMerge CustomersCustomers GETList MachinesMachines 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 Demand OverrideDemand Overrides PATCHUpdate Demand OverrideDemand Overrides GETList Demand OverridesDemand Overrides GETRetrieve Demand OverrideDemand Overrides POSTRelease Production Schedule WeekProduction Schedules POSTCreate Volume DiscountVolume Discounts PATCHUpdate Volume DiscountVolume Discounts GETList Volume DiscountsVolume Discounts GETRetrieve Volume DiscountVolume Discounts POSTQuote Sales Order PricesSales Orders POSTCreate Sales Order LineSales Orders PATCHUpdate Sales Order LineSales Orders PUTClose Sales OrderSales Orders PUTIssue Sales OrderSales Orders PUTReopen Sales OrderSales Orders POSTQuote Sales Order FreightSales Orders PUTUnissue Sales OrderSales Orders

unit example

{
  "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"
}

{
  "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"
}

Units

Attributes

Used by