Skip to content



This function queries and loads a list of notes from a Quote.

Request Parameters#

Type Description
function String For module level functions this parameter will always have the value Module
module_code String The module code will always have the value quote for this function
module_function String Specifies the function being executed, in this case QuoteNoteList_Load_Query
The id of the quote
The code of the quote
The code of the quote
count Number Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
filter String A string for filtering returned data
offset Number Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort String The order for sorting returned data

Response Parameters#

Type Description
success Boolean Boolean value indicating if the API request was successful
total_count Number Total number of notes returned
start_offset Number Starting offset for pagination
id Number Note ID
quote_id Number Quote ID
notetext String The text content of the note
pub Boolean Boolean value indicating if the note is visible to customers
source String Note source
dtstamp Number Unix timestamp for note creation date
user String User name

Example Request#

    "Store_code": "beta",
    "Function": "Module",
    "Module_Code": "quote",
    "Module_Function": "QuoteNoteList_Load_Query",
    "Quote_ID": 1008,
    "Filter": [],
    "Sort": "-",
    "Offset": 0,
    "Count": 18

Example Response#

    "success": 1,
    "data": {
        "total_count": 2,
        "start_offset": 0,
        "data": [
                "id": 17,
                "quote_id": 1008,
                "notetext": "This text replaces the content in note 13 from quote 1008.",
                "pub": false,
                "source": "A",
                "dtstamp": 1621013386,
                "user": ""
                "id": 6,
                "quote_id": 1008,
                "notetext": "Copied from Quote #1003",
                "pub": true,
                "source": "A",
                "dtstamp": 1620797771,
                "user": ""

Error Responses#

Error Code Error Message Error Description
MER-UTL-QUOTES-00343 Quote not found Quote not found
MER-UTL-QUOTES-00346 Unable to load quote: One of Quote_ID, Edit_Quote, or Quote_Code must be specified Unable to load quote