Skip to content

`NoteList_Load_Query`#

Description#

This function allows you load one or more notes associated with a customer, order or business account.

Column	Description
`id`	Note Id
`notetext`	Contents of the note
`dtstamp`	Date/Time Stamp
`cust_id`	Customer Id attached to note
`account_id`	Business Account Id
`order_id`	Order Id attached to note
`admin_user`	Admin User Id
`cust_login`	Customer Login
`business_title`	Business Account Name

Sort Columns#

Column	Description
`id`	Note Id
`notetext`	Contents of the note
`dtstamp`	Date/Time Stamp
`cust_id`	Customer Id attached to note
`account_id`	Business Account Id
`order_id`	Order Id attached to note
`admin_user`	Admin User Id
`cust_login`	Customer Login
`business_title`	Business Account Name

Request Body Parameters#

Parameter	Type	Description
`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#

Parameter	Type	Description
`total_count`	Number	total_count is the total number of records that match your search criteria. Note: this is not always the total products returned. Based on the Count and Offset parameters passed, the number of records returned could be different than the total_count.
`start_offset`	Number	Number number of the starting offset number of products to return. Used in conjunction with the Count parameter for paginating results of large datasets.
`id`	Number	Note Id. Will be needed in update and delete functions.
`cust_id`	Number	Customer Id attached to note. 0 means note is not assigned to any customer
`account_id`	Number	Account Id attached to note. 0 means note is not assigned to any business account
`order_id`	Number	Order Id attached to note. 0 means note is not assigned to any Order
`user_id`	Number	Admin User Id who created the note
`notetext`	String	Contents of Note
`dtstamp`	Unix Timestamp	Date Note was created/updated
`cust_login`	String	Customer Login attached to the note.
`business_title`	String	Name of Business Account attached to the note.
`admin_user`	String	Username of admin user who created the note. Note: This will be empty for notes created via the API.

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "NoteList_Load_Query",
    "Count": 0,
    "Offset": 0,
    "Filter": [
        {
            "name": "search",
            "value": [
                {
                    "field": "order_id",
                    "operator": "EQ",
                    "value": 200107
                }
            ]
        }
    ]
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 1,
        "start_offset": 0,
        "data": [
            {
                "id": 62,
                "cust_id": 1,
                "account_id": 0,
                "order_id": 200107,
                "user_id": 0,
                "notetext": "This is a custom note for an order",
                "dtstamp": 1538162067,
                "cust_login": "bheyde",
                "business_title": "",
                "admin_user": ""
            }
        ]
    }
}