24/7 Support: 800.608.6482

Navigation


ProductVariantList_Load_Query

This function loads a list of product variants for a product.

Request Parameters

store_code Type:
String
Title:
Store Code
Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String
Title:
Product Variant List Load Query
The name of the function being executed
count Type:
Number
Title:
Count
Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
filter Type:
String
Title:
Filter
A string for filtering returned data
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
product_id Type:
Number
Title:
Product ID
The id number of the product

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
total_count Type:
Number
Title:
Total Count
The total number of product variants returned.
start_offset Type:
Number
Title:
Start Offset
The number of pages of results. Default 0 is no offset.
data
+ Show Properties
Type:
Object
Title:
Returned Data
The data set containing product variants
offset Type:
Number
Title:
Offset
The number of pages of results. Default 0 is no offset.
product_id Type:
Number
Title:
Product Id
The product id
variant_id Type:
Number
Title:
Variant Id
The id number of variant
option_id_9_1 Type:
Number
Title:
Option ID 9 1
The option id number of the variant
option_code_9_1 Type:
String
Title:
Option Code 9 1
The option id code of the variant
parts
+ Show Properties
Type:
Object
Title:
Parts
The product variant parts
offset Type:
Number
Title:
Offset
The number of pages of results. Default 0 is no offset.
product_id Type:
Number
Title:
Product Id
The product id of the variant
product_code Type:
String
Title:
Product Code
The product code of the variant
product_sku Type:
String
Title:
Product SKU
The product sku of the variant
product_name Type:
String
Title:
Product Name
Product name of the variant
quantity Type:
Number
Title:
Quantity
The quantity of the variant

Example Request

Example Response

Error Responses

error code:
MER-JSN-PRD-00070
error message:
Product not found
description:
Product id is not found

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.