Class: ProductVariantListLoadProduct

Request~ProductVariantListLoadProduct(clientnullable, productnullable)

Handles API Request ProductVariantList_Load_Product. Scope: Store.

Constructor

new ProductVariantListLoadProduct(clientnullable, productnullable)

ProductVariantListLoadProduct Constructor.

ProductVariantListLoadProduct Constructor.

Parameters:
Name Type Attributes Default Description
client Client <nullable>
product Product <nullable>
 null
Source:
See:

Methods

addExclusion(exclusion) → {ProductVariantListLoadProduct}

Add Exclusions.

Add Exclusions.

Parameters:
Name Type Description
exclusion ProductVariantExclusion
Source:
Throws:
Error
Returns:
Type
ProductVariantListLoadProduct

addExclusions(exclusions) → {ProductVariantListLoadProduct}

Add many ProductVariantExclusion.

Add many ProductVariantExclusion.

Parameters:
Name Type Description
exclusions Array.<ProductVariantExclusion>
Source:
Throws:
Error
Returns:
Type
ProductVariantListLoadProduct

addLimit(limit) → {ProductVariantListLoadProduct}

Add Limits.

Add Limits.

Parameters:
Name Type Description
limit ProductVariantLimit
Source:
Throws:
Error
Returns:
Type
ProductVariantListLoadProduct

addLimits(limits) → {ProductVariantListLoadProduct}

Add many ProductVariantLimit.

Add many ProductVariantLimit.

Parameters:
Name Type Description
limits Array.<ProductVariantLimit>
Source:
Throws:
Error
Returns:
Type
ProductVariantListLoadProduct

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getEditProduct() → {string}

Get Edit_Product.

Get Edit_Product.

Source:
Returns:
Type
string

getExclusions() → {Array.<ProductVariantExclusion>}

Get Exclusions.

Get Exclusions.

Source:
Returns:
Type
Array.<ProductVariantExclusion>

getIncludeDefaultVariant() → {boolean}

Get Include_Default_Variant.

Get Include_Default_Variant.

Source:
Returns:
Type
boolean

getLimits() → {Array.<ProductVariantLimit>}

Get Limits.

Get Limits.

Source:
Returns:
Type
Array.<ProductVariantLimit>

getProductCode() → {string}

Get Product_Code.

Get Product_Code.

Source:
Returns:
Type
string

getProductId() → {number}

Get Product_ID.

Get Product_ID.

Source:
Returns:
Type
number

getProductSku() → {string}

Get Product_SKU.

Get Product_SKU.

Source:
Returns:
Type
string

setEditProduct(editProduct) → {ProductVariantListLoadProduct}

Set Edit_Product.

Set Edit_Product.

Parameters:
Name Type Description
editProduct string
Source:
Returns:
Type
ProductVariantListLoadProduct

setExclusions(exclusions) → {ProductVariantListLoadProduct}

Set Exclusions.

Set Exclusions.

Parameters:
Name Type Description
exclusions Array.<ProductVariantExclusion>
Source:
Throws:
Error
Returns:
Type
ProductVariantListLoadProduct

setIncludeDefaultVariant(includeDefaultVariant) → {ProductVariantListLoadProduct}

Set Include_Default_Variant.

Set Include_Default_Variant.

Parameters:
Name Type Description
includeDefaultVariant boolean
Source:
Returns:
Type
ProductVariantListLoadProduct

setLimits(limits) → {ProductVariantListLoadProduct}

Set Limits.

Set Limits.

Parameters:
Name Type Description
limits Array.<ProductVariantLimit>
Source:
Throws:
Error
Returns:
Type
ProductVariantListLoadProduct

setProductCode(productCode) → {ProductVariantListLoadProduct}

Set Product_Code.

Set Product_Code.

Parameters:
Name Type Description
productCode string
Source:
Returns:
Type
ProductVariantListLoadProduct

setProductId(productId) → {ProductVariantListLoadProduct}

Set Product_ID.

Set Product_ID.

Parameters:
Name Type Description
productId number
Source:
Returns:
Type
ProductVariantListLoadProduct

setProductSku(productSku) → {ProductVariantListLoadProduct}

Set Product_SKU.

Set Product_SKU.

Parameters:
Name Type Description
productSku string
Source:
Returns:
Type
ProductVariantListLoadProduct

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object