Skip to content

Note_Insert#


Descriptions#

This function allows you to insert a note for a customer, business account, or order.

Request Body Parameters#

Parameter
Type Description
NoteText String Text to include in the note.
Customer_ID
Account_ID
Order_ID
Number
Number
Number
Optional value of customer id if note is being attached to the customer record.
Optional Business Account ID if the note is being attached to the Business Account Record.
Optional Order ID if the note is being attached to the Order Record.

Response Parameters#

Parameter
Type Description
success boolean Boolean value indicating if the request was successful

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "Note_Insert",
    "NoteText": "This is a custom note for an order",
    "Order_ID": 200107
}

Example Response#

{
    "success": 1
}

Error Responses#

Error Code Error Message Error Description
MER-JSN-NTE-00004 Invalid note type Missing Order_Id, Customer_Id, or Account_Id Parameter