Item Categories

The item_category object

A grouping of related catalog items that defines the unit group and properties available to the items within it.

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name of the item category.

notesstringnullable

Free-form notes about the item category.

typestringenumValues:material_categoryproduct_category

What kind of items this category groups.

An item can only be assigned to a category whose type matches the item's type.

material_category: groups raw materials and components (items of type material).
product_category: groups finished products and parts (items of type product or part).

ownerownernullable

Owner of the item category.

System-owned categories are platform defaults (the owner.type is system and owner.account is null); account-owned categories were created by your organization.

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.

propertieslistnullable

Properties associated with this item category.

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 property

Resources in this page.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name of the property, such as Color or Size.

attributeslistnullable

Attributes belonging to this property.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

unit_groupunit_groupnullable

Unit group associated with this item category.

This unit group determines the units of measure available to items in this category throughout your production process.

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_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

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.

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.

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.

ownerownernullable

Owner of this resource.

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

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 DELETEDelete Item CategoryItem Categories PUTAdd Item Category PropertyItem Categories PUTChange Item Category Unit GroupItem Categories DELETERemove Item Category PropertyItem Categories POSTCreate MaterialMaterials PATCHUpdate MaterialMaterials GETList MaterialsMaterials GETRetrieve MaterialMaterials DELETEDelete MaterialMaterials POSTCreate PartParts PATCHUpdate PartParts GETList PartsParts GETRetrieve PartParts DELETEDelete PartParts POSTCreate ProductProducts PATCHUpdate ProductProducts GETList ProductsProducts GETRetrieve ProductProducts DELETEDelete ProductProducts PUTChange Product Product LineProducts

item_category example

{
  "id": "ic_01ae7bd7bfd21ca0ab81e1357e",
  "object": "item_category",
  "name": "Electronics",
  "notes": null,
  "type": "material_category",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "properties": null,
  "unit_group": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "ic_01ae7bd7bfd21ca0ab81e1357e",
  "object": "item_category",
  "name": "Electronics",
  "notes": null,
  "type": "material_category",
  "owner": {
    "object": "owner",
    "type": "system",
    "account": null
  },
  "properties": null,
  "unit_group": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}