Get 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.

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

Object type for Property list

page_infoobject

Pagination metadata for Property list

next_cursorstringnullable

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

prev_cursorstringnullable

Cursor 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

Array of Property resources in this page

idstring

Property ID.

objectstringenumValues:property

Resource type identifier.

namestring

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.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Get Item Category