24/7 Support: 800.608.6482

Navigation


ProductKitList_Load_Query

This function loads a list of products in a product kit.

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 Kit List Load Query
The name of the function being executed
product_id Type:
Number
Title:
Product ID
The id number of the product
filter Type:
String
Title:
Filter
A string for filtering returned data
sort Type:
String
Title:
Sort
The order for sorting returned data
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
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

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful
attr_id Type:
Number
Title:
Attribute Id
Attribute id for the product
attr_type Type:
String
Title:
Attribute Type
Attribute Type
attr_code Type:
String
Title:
Attribute Code
Attribute code
attr_prompt Type:
String
Title:
Attribute Prompt
Name of the attribute prompt
attmpat_id Type:
Number
Title:
Attribute Template Attribute ID
The attribute id number of the attribute template
option_id Type:
Number
Title:
Option ID
The id number of the option
option_code Type:
String
Title:
Option Code
The option code
option_prompt Type:
String
Title:
Option Prompt
Name of the option prompt
start_offset Type:
Number
Title:
Start Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
total_count Type:
Number
Title:
Total Count
The total number of items returned in the product kit

Example Request

Example Response

Error Responses

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

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 – 2022 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.