24/7 Support: 800.608.6482

Navigation

QuoteIndex_Load_Id

Starting at zero, this function loads the index position of a quote within a list of quotes.

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

Request Body 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 "QuoteIndex_Load_Id"
quote_id Type:
Number		 Title:
Quote Id		 The id number of the quote
sort Type:
String		 Title:
Sort		 "-id" negative parameter sorts list of quotes in descending order before returning index position

Response Body Parameters

success Type:
Boolean		 Title:
Status Response		 Boolean value indicating if the api request was successful
index Type:
Number		 Title:
Index Number		 Index position of 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

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.