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

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.

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

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)

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 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 Shipping TermShipping Terms PATCHUpdate Shipping TermShipping Terms GETList Shipping TermsShipping Terms GETRetrieve Shipping TermShipping Terms GETList ItemsItems GETRetrieve ItemItems PUTAdd Item AttributeItems PUTChange Item CategoryItems GETRetrieve Item InventoryItems 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 CustomerCustomers PATCHUpdate CustomerCustomers GETList CustomersCustomers GETRetrieve CustomerCustomers POSTMerge CustomersCustomers 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

unit example

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

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

Units

Attributes

Used by