24/7 Support: 800.608.6482

Navigation


QuoteNoteList_Load_Query

This function queries and loads a list of notes 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 "QuoteNoteList_Load_Query"
quote_id Type:
Number
Title:
Quote Id
The id number of the quote being loaded
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 sorts notes 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 Note Count
Total number of notes returned
start_offset Type:
Number
Title:
Start Offset
starting offset for pagination
id Type:
Number
Title:
Note ID
note id
quote_id Type:
Number
Title:
Quote ID
quote id
notetext Type:
String
Title:
Note Text
The text content of the note
pub Type:
Boolean
Title:
Note Public Status
Boolean value indicating if the note is visible to customers
source Type:
String
Title:
Source
note source
dtstamp Type:
Number
Title:
Note Creation Date
Unix time stamp for note creation date
user Type:
String
Title:
User
user name

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

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.