Class: CategoryInsert

Request~CategoryInsert(clientnullable, categorynullable)

Handles API Request Category_Insert. Scope: Store.

Constructor

new CategoryInsert(clientnullable, categorynullable)

CategoryInsert Constructor.

CategoryInsert Constructor.

Parameters:
Name Type Attributes Default Description
client Client <nullable>
category Category <nullable>
 null
Source:
See:

Methods

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getCategoryActive() → {boolean}

Get Category_Active.

Get Category_Active.

Source:
Returns:
Type
boolean

getCategoryAlternateDisplayPage() → {string}

Get Category_Alternate_Display_Page.

Get Category_Alternate_Display_Page.

Source:
Returns:
Type
string

getCategoryCode() → {string}

Get Category_Code.

Get Category_Code.

Source:
Returns:
Type
string

getCategoryName() → {string}

Get Category_Name.

Get Category_Name.

Source:
Returns:
Type
string

getCategoryPageTitle() → {string}

Get Category_Page_Title.

Get Category_Page_Title.

Source:
Returns:
Type
string

getCategoryParentCategory() → {string}

Get Category_Parent_Category.

Get Category_Parent_Category.

Source:
Returns:
Type
string

getCustomFieldValues() → (nullable) {CustomFieldValues}

Get CustomField_Values.

Get CustomField_Values.

Source:
Returns:
Type
CustomFieldValues

setCategoryActive(categoryActive) → {CategoryInsert}

Set Category_Active.

Set Category_Active.

Parameters:
Name Type Description
categoryActive boolean
Source:
Returns:
Type
CategoryInsert

setCategoryAlternateDisplayPage(categoryAlternateDisplayPage) → {CategoryInsert}

Set Category_Alternate_Display_Page.

Set Category_Alternate_Display_Page.

Parameters:
Name Type Description
categoryAlternateDisplayPage string
Source:
Returns:
Type
CategoryInsert

setCategoryCode(categoryCode) → {CategoryInsert}

Set Category_Code.

Set Category_Code.

Parameters:
Name Type Description
categoryCode string
Source:
Returns:
Type
CategoryInsert

setCategoryName(categoryName) → {CategoryInsert}

Set Category_Name.

Set Category_Name.

Parameters:
Name Type Description
categoryName string
Source:
Returns:
Type
CategoryInsert

setCategoryPageTitle(categoryPageTitle) → {CategoryInsert}

Set Category_Page_Title.

Set Category_Page_Title.

Parameters:
Name Type Description
categoryPageTitle string
Source:
Returns:
Type
CategoryInsert

setCategoryParentCategory(categoryParentCategory) → {CategoryInsert}

Set Category_Parent_Category.

Set Category_Parent_Category.

Parameters:
Name Type Description
categoryParentCategory string
Source:
Returns:
Type
CategoryInsert

setCustomFieldValues(customFieldValuesnullable) → {CategoryInsert}

Set CustomField_Values.

Set CustomField_Values.

Parameters:
Name Type Attributes Description
customFieldValues CustomFieldValues <nullable>
Source:
Throws:
Error
Returns:
Type
CategoryInsert

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object