JSDoc: Class: ProductInsert

Constructor

new ProductInsert(clientnullable, productnullable)

ProductInsert Constructor.

Parameters:

Name	Type	Attributes	Default	Description
`client`	Client	<nullable>
`product`	Product	<nullable>	null

Source:

requests.js, line 10488

See:

https://docs.miva.com/json-api/functions/product_insert

Methods

createResponse() → {Response}

Create a response object from the response data.

Source:

requests.js, line 10902

Returns:

Type: Response

getCustomFieldValues() → (nullable) {CustomFieldValues}

Get CustomField_Values.

Source:

requests.js, line 10656

Returns:

Type: CustomFieldValues

getProductActive() → {boolean}

Get Product_Active.

Source:

requests.js, line 10648

Returns:

Type: boolean

getProductAlternateDisplayPage() → {string}

Get Product_Alternate_Display_Page.

Source:

requests.js, line 10576

Returns:

Type: string

getProductCanonicalCategoryCode() → {string}

Get Product_Canonical_Category_Code.

Source:

requests.js, line 10568

Returns:

Type: string

getProductCode() → {string}

Get Product_Code.

Source:

requests.js, line 10536

Returns:

Type: string

getProductCost() → {number}

Get Product_Cost.

Source:

requests.js, line 10616

Returns:

Type: number

getProductDescription() → {string}

Get Product_Description.

Source:

requests.js, line 10560

Returns:

Type: string

getProductImage() → {string}

Get Product_Image.

Source:

requests.js, line 10600

Returns:

Type: string

getProductInventory() → {number}

Get Product_Inventory.

Source:

requests.js, line 10632

Returns:

Type: number

getProductName() → {string}

Get Product_Name.

Source:

requests.js, line 10552

Returns:

Type: string

getProductPageTitle() → {string}

Get Product_Page_Title.

Source:

requests.js, line 10584

Returns:

Type: string

getProductPrice() → {number}

Get Product_Price.

Source:

requests.js, line 10608

Returns:

Type: number

getProductSku() → {string}

Get Product_SKU.

Source:

requests.js, line 10544

Returns:

Type: string

getProductTaxable() → {boolean}

Get Product_Taxable.

Source:

requests.js, line 10640

Returns:

Type: boolean

getProductThumbnail() → {string}

Get Product_Thumbnail.

Source:

requests.js, line 10592

Returns:

Type: string

getProductWeight() → {number}

Get Product_Weight.

Source:

requests.js, line 10624

Returns:

Type: number

setCustomFieldValues(customFieldValuesnullable) → {ProductInsert}

Set CustomField_Values.

Parameters:

Name	Type	Attributes	Description
`customFieldValues`	CustomFieldValues	<nullable>

Source:

requests.js, line 10816

Throws:

Error

Returns:

Type: ProductInsert

setProductActive(productActive) → {ProductInsert}

Set Product_Active.

Parameters:

Name	Type	Description
`productActive`	boolean

Source:

requests.js, line 10805

Returns:

Type: ProductInsert

setProductAlternateDisplayPage(productAlternateDisplayPage) → {ProductInsert}

Set Product_Alternate_Display_Page.

Parameters:

Name	Type	Description
`productAlternateDisplayPage`	string

Source:

requests.js, line 10715

Returns:

Type: ProductInsert

setProductCanonicalCategoryCode(productCanonicalCategoryCode) → {ProductInsert}

Set Product_Canonical_Category_Code.

Parameters:

Name	Type	Description
`productCanonicalCategoryCode`	string

Source:

requests.js, line 10705

Returns:

Type: ProductInsert

setProductCode(productCode) → {ProductInsert}

Set Product_Code.

Parameters:

Name	Type	Description
`productCode`	string

Source:

requests.js, line 10665

Returns:

Type: ProductInsert

setProductCost(productCost) → {ProductInsert}

Set Product_Cost.

Parameters:

Name	Type	Description
`productCost`	number

Source:

requests.js, line 10765

Returns:

Type: ProductInsert

setProductDescription(productDescription) → {ProductInsert}

Set Product_Description.

Parameters:

Name	Type	Description
`productDescription`	string

Source:

requests.js, line 10695

Returns:

Type: ProductInsert

setProductImage(productImage) → {ProductInsert}

Set Product_Image.

Parameters:

Name	Type	Description
`productImage`	string

Source:

requests.js, line 10745

Returns:

Type: ProductInsert

setProductInventory(productInventory) → {ProductInsert}

Set Product_Inventory.

Parameters:

Name	Type	Description
`productInventory`	number

Source:

requests.js, line 10785

Returns:

Type: ProductInsert

setProductName(productName) → {ProductInsert}

Set Product_Name.

Parameters:

Name	Type	Description
`productName`	string

Source:

requests.js, line 10685

Returns:

Type: ProductInsert

setProductPageTitle(productPageTitle) → {ProductInsert}

Set Product_Page_Title.

Parameters:

Name	Type	Description
`productPageTitle`	string

Source:

requests.js, line 10725

Returns:

Type: ProductInsert

setProductPrice(productPrice) → {ProductInsert}

Set Product_Price.

Parameters:

Name	Type	Description
`productPrice`	number

Source:

requests.js, line 10755

Returns:

Type: ProductInsert

setProductSku(productSku) → {ProductInsert}

Set Product_SKU.

Parameters:

Name	Type	Description
`productSku`	string

Source:

requests.js, line 10675

Returns:

Type: ProductInsert

setProductTaxable(productTaxable) → {ProductInsert}

Set Product_Taxable.

Parameters:

Name	Type	Description
`productTaxable`	boolean

Source:

requests.js, line 10795

Returns:

Type: ProductInsert

setProductThumbnail(productThumbnail) → {ProductInsert}

Set Product_Thumbnail.

Parameters:

Name	Type	Description
`productThumbnail`	string

Source:

requests.js, line 10735

Returns:

Type: ProductInsert

setProductWeight(productWeight) → {ProductInsert}

Set Product_Weight.

Parameters:

Name	Type	Description
`productWeight`	number

Source:

requests.js, line 10775

Returns:

Type: ProductInsert

toObject() → {Object}

Reduce the request to a an object.

Source:

requests.js, line 10833

Returns:

Type: Object