24/7 Support: 800.608.6482

Navigation


RelatedProductList_Load_Query

This function loads a list of related products by product id.

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:
Related Product List Load Query
The name of the function being executed
assigned Type:
Boolean
Title:
Assigned
Boolean value indicating if the query returns currently assigned related products
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
sort Type:
String
Title:
Sort
The order for sorting returned data
unassigned Type:
Boolean
Title:
Unassigned
Boolean value indicating if the query returns unassigned related products

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 number of related products returned
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data
assigned Type:
Boolean
Title:
Assigned
Boolean value indicating if the related product is currently assigned to the product
id Type:
Number
Title:
Product ID
The related product id
code Type:
String
Title:
Product Code
The related product code
sku Type:
String
Title:
Product SKU
The related product sku
name Type:
String
Title:
Product Name
The related product name
thumbnail Type:
String
Title:
Product Thumbnail
The filepath for the related product thumbnail
image Type:
String
Title:
Product Image
The filepath for the related product image
price Type:
Number
Title:
Product Price
The price of the related product
formatted_price Type:
String
Title:
Currency Formatted Product Price
Currency formatted price of the related product
cost Type:
Number
Title:
Product Cost
The related product cost
formatted_cost Type:
String
Title:
Currency Formatted Product Cost
Currency formatted related product cost
weight Type:
Number
Title:
Product Weight
The related product weight
taxable Type:
Boolean
Title:
Tax Exempt Product Status
Boolean value indicating if the related product is taxable
active Type:
Boolean
Title:
Active Product
Boolean value indicating if the related product is active
page_title Type:
String
Title:
Product Page Title
The title of the related product page
dt_created Type:
Number
Title:
Product Creation Date
Unix timestamp for the related product creation date
dt_updated Type:
Number
Title:
Product Update Date
Unix timestamp for the related product's most recent update

Example Request

Example Response

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