Class: Product

Methods

getActive() → {boolean}

Get active.

Source:

• models.js, line 1916

Returns:

Type

boolean

getAttributes() → {Array.<ProductAttribute>}

Get attributes.

Source:

• models.js, line 2044

Returns:

Type

Array.<ProductAttribute>

getCanonicalCategoryCode() → {string}

Get cancat_code.

Source:

• models.js, line 1980

Returns:

Type

string

getCategories() → {Array.<Category>}

Get categories.

Source:

• models.js, line 2020

Returns:

Type

Array.<Category>

getCategoryCount() → {number}

Get catcount.

Source:

• models.js, line 1900

Returns:

Type

number

getCode() → {string}

Get code.

Source:

• models.js, line 1820

Returns:

Type

string

getCost() → {number}

Get cost.

Source:

• models.js, line 1876

Returns:

Type

number

getCustomFieldValues() → {CustomFieldValues|*}

Get CustomField_Values.

Source:

• models.js, line 1996

Returns:

Type

CustomFieldValues | *

getDateTimeCreated() → {number}

Get dt_created.

Source:

• models.js, line 1940

Returns:

Type

number

getDateTimeUpdate() → {number}

Get dt_updated.

Source:

• models.js, line 1948

Returns:

Type

number

getDescription() → {string}

Get descrip.

Source:

• models.js, line 1892

Returns:

Type

string

getFormattedCost() → {string}

Get formatted_cost.

Source:

• models.js, line 1884

Returns:

Type

string

getFormattedPrice() → {string}

Get formatted_price.

Source:

• models.js, line 1868

Returns:

Type

string

getId() → {number}

Get id.

Source:

• models.js, line 1812

Returns:

Type

number

getImage() → {string}

Get image.

Source:

• models.js, line 1852

Returns:

Type

string

getName() → {string}

Get name.

Source:

• models.js, line 1836

Returns:

Type

string

getPageCode() → {string}

Get page_code.

Source:

• models.js, line 1988

Returns:

Type

string

getPageTitle() → {string}

Get page_title.

Source:

• models.js, line 1924

Returns:

Type

string

getPrice() → {number}

Get price.

Source:

• models.js, line 1860

Returns:

Type

number

getProductImageData() → {Array.<ProductImageData>}

Get productimagedata.

Source:

• models.js, line 2036

Returns:

Type

Array.<ProductImageData>

getProductInventory() → {number}

Get product_inventory.

Source:

• models.js, line 1972

Returns:

Type

number

getProductInventoryActive() → {boolean}

Get product_inventory_active.

Source:

• models.js, line 1964

Returns:

Type

boolean

getProductInventorySettings() → {ProductInventorySettings|*}

Get productinventorysettings.

Source:

• models.js, line 1956

Returns:

Type

ProductInventorySettings | *

getProductShuppingRules() → {ProductShippingRules|*}

Get productshippingrules.

Source:

• models.js, line 2028

Returns:

Type

ProductShippingRules | *

getRelatedProducts() → {Array.<RelatedProduct>}

Get relatedproducts.

Source:

• models.js, line 2012

Returns:

Type

Array.<RelatedProduct>

getSku() → {string}

Get sku.

Source:

• models.js, line 1828

Returns:

Type

string

getTaxable() → {boolean}

Get taxable.

Source:

• models.js, line 1932

Returns:

Type

boolean

getThumbnail() → {string}

Get thumbnail.

Source:

• models.js, line 1844

Returns:

Type

string

getUris() → {Array.<Uri>}

Get uris.

Source:

• models.js, line 2004

Returns:

Type

Array.<Uri>

getWeight() → {number}

Get weight.

Source:

• models.js, line 1908

Returns:

Type

number

setActive(active) → {Product}

Set active.

Parameters:

Source:

• models.js, line 2134

Returns:

Type

Product

setCanonicalCategoryCode(canonicalCategoryCode) → {Product}

Set cancat_code.

Parameters:

Source:

• models.js, line 2170

Returns:

Type

Product

setCode(code) → {Product}

Set code.

Parameters:

Source:

• models.js, line 2053

Returns:

Type

Product

setCost(cost) → {Product}

Set cost.

Parameters:

Source:

• models.js, line 2107

Returns:

Type

Product

setCustomFieldValues(customFieldValues) → {Product}

Set CustomField_Values.

Parameters:

Source:

• models.js, line 2189

Throws:

Returns:

Type

Product

setDescription(description) → {Product}

Set descrip.

Parameters:

Source:

• models.js, line 2116

Returns:

Type

Product

setImage(image) → {Product}

Set image.

Parameters:

Source:

• models.js, line 2089

Returns:

Type

Product

setName(name) → {Product}

Set name.

Parameters:

Source:

• models.js, line 2071

Returns:

Type

Product

setPageCode(pageCode) → {Product}

Set page_code.

Parameters:

Source:

• models.js, line 2179

Returns:

Type

Product

setPageTitle(pageTitle) → {Product}

Set page_title.

Parameters:

Source:

• models.js, line 2143

Returns:

Type

Product

setPrice(price) → {Product}

Set price.

Parameters:

Source:

• models.js, line 2098

Returns:

Type

Product

setProductInventory(productInventory) → {Product}

Set product_inventory.

Parameters:

Source:

• models.js, line 2161

Returns:

Type

Product

setSku(sku) → {Product}

Set sku.

Parameters:

Source:

• models.js, line 2062

Returns:

Type

Product

setTaxable(taxable) → {Product}

Set taxable.

Parameters:

Source:

• models.js, line 2152

Returns:

Type

Product

setThumbnail(thumbnail) → {Product}

Set thumbnail.

Parameters:

Source:

• models.js, line 2080

Returns:

Type

Product

setWeight(weight) → {Product}

Set weight.

Parameters:

Source:

• models.js, line 2125

Returns:

Type

Product

toObject()

Source:

• models.js, line 2203