24/7 Support: 800.608.6482

Navigation


QuoteList_Load_Query

This function loads a list of quotes.

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 "QuoteList_Load_Query"
filter Type:
Object
Title:
Filter
Array of objects containing search filters. See usage here: List Load Query Overview
sort Type:
String
Title:
Sort
"-" negative parameter returns quotes in descending order
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
total_count Type:
Number
Title:
Total Quote Count
Total number of quotes returned
start_offset Type:
Number
Title:
Start Offset
starting offset value for pagination of the response data
id Type:
Number
Title:
quote ID
quote id
cust_id Type:
Number
Title:
Customer ID
customer id
order_id Type:
Number
Title:
Order ID
order_id associated with the quote
code Type:
String
Title:
Quote Code
quote code
email Type:
String
Title:
Email Address
email
fname Type:
String
Title:
First Name
first name
lname Type:
String
Title:
Last Name
last name
phone Type:
String
Title:
Phone Number
phone number
zip Type:
String
Title:
Zip Code
zip code
country Type:
String
Title:
Country
country
comment Type:
String
Title:
Comment
quote comments
status Type:
Number
Title:
Quote Status
quote status
created Type:
Number
Title:
Created Date
Unix timestamp for quote creation date
total Type:
Number
Title:
Quote Total
total
formatted_total Type:
String
Title:
Currency Formatted Total
formatted total
terms Type:
String
Title:
Terms
terms
expires Type:
Number
Title:
Quote Expiration Date
Unix timestamp for quote expiration date

Example Request

Example Response

Error Responses

error code:
MER-UTL-QUOTES-00343
error message:
Quote not found
description:
Quote 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 – 2021 Miva©, Miva Merchant©, MivaPay©, MivaCon© Miva, Inc. All Rights Reserved.