24/7 Support: 800.608.6482

Get Started

Navigation


NoteList_Load_Query

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

Search Filter Columns

id notetext dtstamp
cust_id account_id order_id
admin_user cust_login business_title

Sort Columns

id notetext dtstamp
cust_id account_id order_id
admin_user cust_login business_title

Request Body Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many notes you want returned. If for example you are querying thousands of notes you'll want to set the count to limit how many you get back in a single request.
offset Type:
Offset
Title:
Number
Used in conjunction with the Count parameter for paginating results of large datasets. Default is 0 whcih is no offset.
sort Type:
String
Title:
Sort
Field to sort results by. Avaiilable sorting fields listed above. Use - prefix for a decending sort.
Filter Type:
Object
Title:
Filter
Array of Object containing search filters. See usage here: List Load Query Overview

Response Parameters

total_count Type:
Number
Title:
Total Product Count
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 Type:
Number
Title:
Start Offset
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 Type:
Number
Title:
Note Id
Note Id. Will be needed in update and delete functions.
cust_id Type:
Number
Title:
Customer Id
Customer Id attached to note. 0 means note is not assigned to any customer
account_id Type:
Number
Title:
Business Account Id
Account Id attached to note. 0 means note is not assigned to any business account
order_id Type:
Number
Title:
Order Id
Order Id attached to note. 0 means note is not assigned to any Order
user_id Type:
Number
Title:
User Id
Admin User Id who created the note
notetext Type:
String
Title:
Note Text
Contents of Note
dtstamp Type:
Unix Timestamp
Title:
Date/Time Stamp
Date Note was created/updated
cust_login Type:
String
Title:
Customer Login
Customer Login attached to the note.
business_title Type:
String
Title:
Business Account Name
Name of Business Account attached to the note.
admin_user Type:
String
Title:
Admin Username
Username of admin user who created the note. Note: This will be empty for notes created via the API.

Example Request

Example Response

This website uses cookies to identify visitors, track visitors to our website, store login session information and to remember your user preferences. By continuing to use this site you agree to our use of cookies. Learn More.

This website uses cookies. By continuing to use this site you agree to our use of cookies. Learn More.

Accept

Miva believes that all online businesses should have access to a scalable ecommerce platform that can meet their unique business requirements. Miva offers PCI compliant ecommerce, hosting, and custom website design and development solutions. Miva customers have processed over $100 billion in online sales since 1997.

Copyright © 2016 Miva, Inc - All Rights Reserved   Privacy Policy | Store Policy

Links
Contact Us
Receive Tips & Updates

Copyright © 2017 Miva, Inc - All Rights Reserved

Back To The Top