JSDoc: Class: ProductUpdate

Constructor

new ProductUpdate(clientnullable, productnullable)

ProductUpdate Constructor.

Parameters:

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

Source:

requests.js, line 11050

See:

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

Methods

createResponse() → {Response}

Create a response object from the response data.

Source:

requests.js, line 11520

Returns:

Type: Response

getCustomFieldValues() → (nullable) {CustomFieldValues}

Get CustomField_Values.

Source:

requests.js, line 11242

Returns:

Type: CustomFieldValues

getEditProduct() → {string}

Get Edit_Product.

Source:

requests.js, line 11122

Returns:

Type: string

getProductActive() → {boolean}

Get Product_Active.

Source:

requests.js, line 11234

Returns:

Type: boolean

getProductAlternateDisplayPage() → {string}

Get Product_Alternate_Display_Page.

Source:

requests.js, line 11162

Returns:

Type: string

getProductCanonicalCategoryCode() → {string}

Get Product_Canonical_Category_Code.

Source:

requests.js, line 11154

Returns:

Type: string

getProductCode() → {string}

Get Product_Code.

Source:

requests.js, line 11114

Returns:

Type: string

getProductCost() → {number}

Get Product_Cost.

Source:

requests.js, line 11202

Returns:

Type: number

getProductDescription() → {string}

Get Product_Description.

Source:

requests.js, line 11146

Returns:

Type: string

getProductId() → {number}

Get Product_ID.

Source:

requests.js, line 11106

Returns:

Type: number

getProductImage() → {string}

Get Product_Image.

Source:

requests.js, line 11186

Returns:

Type: string

getProductInventory() → {number}

Get Product_Inventory.

Source:

requests.js, line 11218

Returns:

Type: number

getProductName() → {string}

Get Product_Name.

Source:

requests.js, line 11138

Returns:

Type: string

getProductPageTitle() → {string}

Get Product_Page_Title.

Source:

requests.js, line 11170

Returns:

Type: string

getProductPrice() → {number}

Get Product_Price.

Source:

requests.js, line 11194

Returns:

Type: number

getProductSku() → {string}

Get Product_SKU.

Source:

requests.js, line 11130

Returns:

Type: string

getProductTaxable() → {boolean}

Get Product_Taxable.

Source:

requests.js, line 11226

Returns:

Type: boolean

getProductThumbnail() → {string}

Get Product_Thumbnail.

Source:

requests.js, line 11178

Returns:

Type: string

getProductWeight() → {number}

Get Product_Weight.

Source:

requests.js, line 11210

Returns:

Type: number

setCustomFieldValues(customFieldValuesnullable) → {ProductUpdate}

Set CustomField_Values.

Parameters:

Name	Type	Attributes	Description
`customFieldValues`	CustomFieldValues	<nullable>

Source:

requests.js, line 11422

Throws:

Error

Returns:

Type: ProductUpdate

setEditProduct(editProduct) → {ProductUpdate}

Set Edit_Product.

Parameters:

Name	Type	Description
`editProduct`	string

Source:

requests.js, line 11271

Returns:

Type: ProductUpdate

setProductActive(productActive) → {ProductUpdate}

Set Product_Active.

Parameters:

Name	Type	Description
`productActive`	boolean

Source:

requests.js, line 11411

Returns:

Type: ProductUpdate

setProductAlternateDisplayPage(productAlternateDisplayPage) → {ProductUpdate}

Set Product_Alternate_Display_Page.

Parameters:

Name	Type	Description
`productAlternateDisplayPage`	string

Source:

requests.js, line 11321

Returns:

Type: ProductUpdate

setProductCanonicalCategoryCode(productCanonicalCategoryCode) → {ProductUpdate}

Set Product_Canonical_Category_Code.

Parameters:

Name	Type	Description
`productCanonicalCategoryCode`	string

Source:

requests.js, line 11311

Returns:

Type: ProductUpdate

setProductCode(productCode) → {ProductUpdate}

Set Product_Code.

Parameters:

Name	Type	Description
`productCode`	string

Source:

requests.js, line 11261

Returns:

Type: ProductUpdate

setProductCost(productCost) → {ProductUpdate}

Set Product_Cost.

Parameters:

Name	Type	Description
`productCost`	number

Source:

requests.js, line 11371

Returns:

Type: ProductUpdate

setProductDescription(productDescription) → {ProductUpdate}

Set Product_Description.

Parameters:

Name	Type	Description
`productDescription`	string

Source:

requests.js, line 11301

Returns:

Type: ProductUpdate

setProductId(productId) → {ProductUpdate}

Set Product_ID.

Parameters:

Name	Type	Description
`productId`	number

Source:

requests.js, line 11251

Returns:

Type: ProductUpdate

setProductImage(productImage) → {ProductUpdate}

Set Product_Image.

Parameters:

Name	Type	Description
`productImage`	string

Source:

requests.js, line 11351

Returns:

Type: ProductUpdate

setProductInventory(productInventory) → {ProductUpdate}

Set Product_Inventory.

Parameters:

Name	Type	Description
`productInventory`	number

Source:

requests.js, line 11391

Returns:

Type: ProductUpdate

setProductName(productName) → {ProductUpdate}

Set Product_Name.

Parameters:

Name	Type	Description
`productName`	string

Source:

requests.js, line 11291

Returns:

Type: ProductUpdate

setProductPageTitle(productPageTitle) → {ProductUpdate}

Set Product_Page_Title.

Parameters:

Name	Type	Description
`productPageTitle`	string

Source:

requests.js, line 11331

Returns:

Type: ProductUpdate

setProductPrice(productPrice) → {ProductUpdate}

Set Product_Price.

Parameters:

Name	Type	Description
`productPrice`	number

Source:

requests.js, line 11361

Returns:

Type: ProductUpdate

setProductSku(productSku) → {ProductUpdate}

Set Product_SKU.

Parameters:

Name	Type	Description
`productSku`	string

Source:

requests.js, line 11281

Returns:

Type: ProductUpdate

setProductTaxable(productTaxable) → {ProductUpdate}

Set Product_Taxable.

Parameters:

Name	Type	Description
`productTaxable`	boolean

Source:

requests.js, line 11401

Returns:

Type: ProductUpdate

setProductThumbnail(productThumbnail) → {ProductUpdate}

Set Product_Thumbnail.

Parameters:

Name	Type	Description
`productThumbnail`	string

Source:

requests.js, line 11341

Returns:

Type: ProductUpdate

setProductWeight(productWeight) → {ProductUpdate}

Set Product_Weight.

Parameters:

Name	Type	Description
`productWeight`	number

Source:

requests.js, line 11381

Returns:

Type: ProductUpdate

toObject() → {Object}

Reduce the request to a an object.

Source:

requests.js, line 11439

Returns:

Type: Object