Retrieve Item Category

Beta

GET/v1/catalog/item-categories/{id}

This endpoint is idempotent. Learn more

Returns an item category by ID. Includes account-specific and global system categories.

idstring

Item category ID.

include[]optional arrayenumValues:ownerowner.accountproperties

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

idstring

Item category ID.

objectstringenumValues:item_category

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:material_categoryproduct_category

Item category type.

ownerobjectExpandablenullable

Owner of the item category.

objectstringenumValues:owner

Resource type identifier.

typestringenumValues:systemaccount

The owner type: "system" for platform defaults, "account" for account-owned resources.

accountobjectExpandablenullable

The account that owns this resource. null if the object is system-owned.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

propertiesobjectExpandablenullable

Properties associated with this item category.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if 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 object

Resources in this page.

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

Display name.

attributesobjectnullable

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_groupobjectExpandablenullable

Unit group associated with this item category. This unit group dictates the available units that items in this category may embody in your production process.

idstring

Unit group ID.

objectstringenumValues:unit_group

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes.

typestringenumValues:currencyquantitytime

Unit type.

base_unitobjectnullable

Base unit.

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

Unit dimension.

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.

ownerobjectnullable

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_unitsobjectnullable

Associated units.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if 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 object

Resources in this page.

idstring

Unit group unit ID.

objectstringenumValues:unit_group_unit

Resource type identifier.

unitobjectnullable

Unit.

Always returned as null in this endpoint.

discount_percentagenumber

Discount percentage.

discount_fixednumber

Fixed discount amount.

customer_portal_visibilitystringenumValues:visiblehidden

Customer portal visibility.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

ownerobjectExpandablenullable

Owner.

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 Retrieve Item Category

Retrieve Item Category

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const itemCategory = await client.catalog.itemCategories.retrieve('ic_01ae7bd7bfd21ca0ab81e1357e');

console.log(itemCategory.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const itemCategory = await client.catalog.itemCategories.retrieve('ic_01ae7bd7bfd21ca0ab81e1357e');

console.log(itemCategory.id);

200 example

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

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

Retrieve Item Category

Path Parameters

Query Parameters

Returns

Responses