24/7 Support: 800.608.6482

Navigation

Quote_Load_ID

This function loads the meta details of 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 "Quote_Load_ID"
quote_id Type:
Number		 Title:
Quote ID		 id number of the quote

Response Parameters

success Type:
Boolean		 Title:
Status Response		 Boolean value indicating if the api request was successful
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 the 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 the quote expiration date

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

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.