Class CategoryLink

A CategoryLink represents a directed relationship between two catalog categories. Merchants create category links in order to market similar or related groups of products.

Constant Summary 

ConstantDescription
LINKTYPE_ACCESSORY: Number = 2Represents an accessory category link.
LINKTYPE_CROSS_SELL: Number = 4Represents a cross-sell category link.
LINKTYPE_OTHER: Number = 1Represents a miscellaneous category link.
LINKTYPE_SPARE_PART: Number = 6Represents a spare part category link.
LINKTYPE_UP_SELL: Number = 5Represents an up-sell category link.

Property Summary 

PropertyDescription
sourceCategory: Category (read-only)Returns the object for the relation ‘sourceCategory’.
targetCategory: Category (read-only)Returns the object for the relation ‘targetCategory’.
typeCode: Number (read-only)Returns the type of this category link (see constants).

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

MethodDescription
getSourceCategory()Returns the object for the relation ‘sourceCategory’.
getTargetCategory()Returns the object for the relation ‘targetCategory’.
getTypeCode()Returns the type of this category link (see constants).

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Constant Details 

LINKTYPE_ACCESSORY 

LINKTYPE_ACCESSORY: Number = 2

Represents an accessory category link.


LINKTYPE_CROSS_SELL 

LINKTYPE_CROSS_SELL: Number = 4

Represents a cross-sell category link.


LINKTYPE_OTHER 

LINKTYPE_OTHER: Number = 1

Represents a miscellaneous category link.


LINKTYPE_SPARE_PART 

LINKTYPE_SPARE_PART: Number = 6

Represents a spare part category link.


LINKTYPE_UP_SELL 

LINKTYPE_UP_SELL: Number = 5

Represents an up-sell category link.


Property Details 

sourceCategory 

sourceCategory: Category (read-only)

Returns the object for the relation 'sourceCategory'.


targetCategory 

targetCategory: Category (read-only)

Returns the object for the relation 'targetCategory'.


typeCode 

typeCode: Number (read-only)

Returns the type of this category link (see constants).


Method Details 

getSourceCategory() 

getSourceCategory(): Category

Returns the object for the relation 'sourceCategory'.

Returns:

  • the object for the relation 'sourceCategory'

getTargetCategory() 

getTargetCategory(): Category

Returns the object for the relation 'targetCategory'.

Returns:

  • the object for the relation 'targetCategory'

getTypeCode() 

getTypeCode(): Number

Returns the type of this category link (see constants).

Returns:

  • the type of the link.