24/7 Support: 800.608.6482

Navigation

QuoteItemList_Load

This function loads a list of items from a Quote.

Quote may be specified using one of Quote_ID, Edit_Quote, or Quote_Code. Only one indentifier is needed.

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:
Module		 For module level functions this parameter will always have the value "Module"
module_code Type:
String		 Title:
Quote		 The module code will always have the value "quote" for this function
module_function Type:
String		 Title:
Module_Function		 Specifies the function being executed, in this case "QuoteItemList_Load"
quote_id Type:
Number		 Title:
Quote Id		 The id number of the quote being loaded

Response Parameters

success Type:
Boolean		 Title:
Status Response		 Boolean value indicating if the api request was successful
quote_id Type:
Number		 Title:
Quote Id		 The id number of the loaded quote
line_id Type:
Number		 Title:
Quote Line ID		 The line_id number of the item in the quote
product_id Type:
Number		 Title:
Product ID		 The product_id number of the item in the quote
code Type:
String		 Title:
Product Code		 The product_code of the item in the quote
name Type:
String		 Title:
Product Name		 The product name of the item in the quote
sku Type:
String		 Title:
Product SKU		 The product sku number of the item in the quote
price Type:
Number		 Title:
Product Price		 The price of the item in the quote
base_price Type:
Number		 Title:
Product Base Price		 The base price of the item in the quote
weight Type:
Number		 Title:
Product Weight		 The product weight of the item in the quote
taxable Type:
Boolean		 Title:
Product Taxable Status		 The taxable status of the item in the quote
upsold Type:
Boolean		 Title:
Product Upsold Status		 The upsold status of the item in the quote
quantity Type:
Number		 Title:
Product Quote Quantity		 The quantity of the item in the quote
options
+ Show Properties		 Type:
Object		 Title:
Product Options		 Product Options
quote_id Type:
Number		 Title:
Quote Id		 The id number of the loaded quote
line_id Type:
Number		 Title:
Quote Line ID		 The line_id number of the item in the quote
attr_id Type:
Number		 Title:
Attribute ID		 Item Attribute ID
attr_code Type:
String		 Title:
Attribute Code		 Item Attribute Code
attmpat_id Type:
Number		 Title:
Attribute Template ID		 Attribute Template ID
option_id Type:
Number		 Title:
Product Option Code ID		 Option Code ID
opt_code Type:
String		 Title:
Product Option Code		 Product Option Code
price Type:
Number		 Title:
Product Attribute Price		 Product Attribute Price
base_price Type:
Number		 Title:
Product Attribute Base Price		 Product Attribute Base Price
weight Type:
Number		 Title:
Product Attribute Weight		 weight
data Type:
String		 Title:
Product Attribute Data Field		 Attribute specific data
data_long Type:
String		 Title:
Product Attribute Data Long Field		 Long data field for attribute specific data
attr_prompt Type:
String		 Title:
Attribute Selection Prompt		 Attribute cateogry selection prompt
opt_prompt Type:
String		 Title:
Product Attribute Option Selection		 Attribute option selection prompt
attribute Type:
String		 Title:
Product Attribute Option Name		 Name of the attribute option
value Type:
String		 Title:
Attribute Option Value		 Attribute option selected
total Type:
Number		 Title:
Total Item Price		 The total price of the item in the quote

Example Request

Example Response

Error Responses

error code:
MER-UTL-QUOTES-00343		 error message:
Quote not found		 description:
Quote not found
error code:
MER-UTL-QUOTES-00346		 error message:
Unable to load quote: One of Quote_ID, Edit_Quote, or Quote_Code must be specified		 description:
Unable to load quote
error code:
MER-JSN-00023		 error message:
One or more parameters are invalid		 description:
Missing line_id(s) parameter

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