RestCategory Object

Represents a category, and its place in the category tree.

Type

Name

Description

Int

CategoryId

Bullseye category ID

String

CategoryName

The name of the category

String

ThirdPartyID

Optional third-party ID

String

CategoryData

Optional additional data for this category

Nullable int

ParentCategoryID

Id of this category’s parent. Null if this is a root category.

Int

Depth

Depth of this category in the tree. 0 for root category.

String

Lineage

A string representing the lineage of this category.

This is a sequence of category ids from the root to this entry, separated by vertical bars. For example, if category 3 was under category 1 and 2, this value would be “|1|2|”. (It will be just “|” if root.)

Int

POS

String

ImageFileURL

Optional image URL

List <RestAttribute Object>

Attributes

A list of attributes related to the category.