24/7 Support: 800.608.6482

Get Started

Navigation


ProductVariantList_Load_Product

This function allows you to load variant products and their parts.

Variants in Miva are the different attribute combinations typically used to track inventory at the attribute level

Request Body Parameters

Product_Code Type:
String
Title:
Product Code
Product Code to load variants from
Include_Default_Variant Type:
Boolean
Title:
Include Default Variant
Boolean Value to include the default variant
Limits
+ Show Properties
Type:
Object
Title:
Limits
limits the results to variants that include attributes/options defined
attr_id Type:
Number
Title:
Attribute Id
Attribute ID
attmpat_id Type:
Number
Title:
Attribute Template Id
Attribute Template Id
option_id Type:
Number
Title:
Option Id
Option ID
Exclusions
+ Show Properties
Type:
Object
Title:
Exclusions
limits the results to variants that do not include attributes/options defined
attr_id Type:
Number
Title:
Attribute Id
Attribute ID
attmpat_id Type:
Number
Title:
Attribute Template Id
Attribute Template Id
option_id Type:
Number
Title:
Option Id
Option ID

Response Parameters

product_id Type:
Number
Title:
Product Id
Product Id
variant_id Type:
Number
Title:
Variant ID
Variant Id
Parts
+ Show Properties
Type:
Object
Title:
Parts
Parts which make up the variant. Unless the varaint is a kit, each variant will have a single part. The part is the non-active product used to store pricing and inventory data.
product_id Type:
Number
Title:
Product Id
Product ID
product_code Type:
String
Title:
Product Code
Part Product Code
product_name Type:
String
Title:
Product Name
Part Product Name
quantity Type:
Number
Title:
Quantity
Part Quantity. This will always be 1 unless the item is setup as a kit.
Dimensions
+ Show Properties
Type:
Object
Title:
Exclusions
Dimensions is an object containing the different combination of attributes which make up this variant.
attr_id Type:
Number
Title:
Attribute Id
Attribute ID
attmpat_id Type:
Number
Title:
Attribute Template Id
Attribute Template Id
option_id Type:
Number
Title:
Option Id
Option ID
option_code Type:
String
Title:
Option Code
Option Code

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Copyright © 1997 – 2019 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.