This function deletes a note from a quote.
Request Body Parameters#
| Parameter | Type | Required | Description |
|---|---|---|---|
store_code |
String | Yes | Store Code to run the function against. Found in the Miva Admin under Settings > Store Details |
function |
String | Yes | 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_Delete |
|
note_ids |
Array | Yes | Array of the id numbers of the notes being deleted |
Response Body Parameters#
| Parameter | Type | Description |
|---|---|---|
success |
Boolean | Boolean value indicating if the API request was successful |
processed |
Number | Number of note changes processed |
Example Request#
{
"Store_Code": "{{Store_Code}}",
"Miva_Request_Timestamp": "{{$timestamp}}",
"Function": "Module",
"Module_Code": "quote",
"Module_Function": "QuoteNoteList_Delete",
"Note_IDs": [14]
}
Example Response#
{
"success": 1,
"processed": 1
}
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 |