24/7 Support: 800.608.6482

Navigation

CustomerList_Load_Query

This function allows you to load a list of customer records from Miva.

See the List Load Query Overview guide to get started.

Request Body Parameters

count Type:
Number		 Title:
Count		 Count is used to tell Miva how many customers you want returned. If for example you are querying thousands of customers 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 below. Use - prefix for a decending sort.
Filter Type:
Object		 Title:
Filter		 Array of Object containing search filters. See usage here: List Load Query Overview

On Demand Columns

CustomField_Values:* See custom field usage here: https://docs.miva.com/json-api/list-load-query-overview

Response Parameters

total_count Type:
Number		 Title:
Total Count		 total_count is the total number of records that match your search criteria. Note: this is not always the total customers 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 customers to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id Type:
Number		 Title:
Customer Id		 Customer Id
account_id Type:
Number		 Title:
Business Account Id		 Business Account Id
login Type:
String		 Title:
Customer Login		 Customer Login
pw_email Type:
String		 Title:
Customer Forgot Password Email		 Forgot Password Email
ship_id Type:
Number		 Title:
Shipping Address ID		 Address Book Shipping Address ID
ship_res Type:
Boolean		 Title:
Customer Ship Residential Flag		 Boolean flag used to determine if commercial or resential rates are returned.
ship_fname Type:
String		 Title:
Shipping First Name		 Shipping First Name
ship_lname Type:
String		 Title:
Shipping Last Name		 Customer Last Name
ship_email Type:
String		 Title:
Shipping Email Address		 Shipping Email Address
ship_comp Type:
String		 Title:
Shipping Company		 Shipping Company
ship_phone Type:
String		 Title:
Shipping Phone Number		 Shipping Phone Number
ship_fax Type:
String		 Title:
Shipping Fax Number		 Shipping Fax Number
ship_addr1 Type:
String		 Title:
Shipping Address 1		 Shipping Address 1
ship_addr2 Type:
String		 Title:
Shipping Address 2		 Shipping Address 2
ship_city Type:
String		 Title:
Shipping City		 Shipping City
ship_state Type:
String		 Title:
Shipping State		 Shipping State. 2 digit state code
ship_zip Type:
String		 Title:
Shipping Zip Code		 Shipping Zip Code
ship_cntry Type:
String		 Title:
Shipping Country		 Shipping Country. 2 digit country code
bill_id Type:
Number		 Title:
Billing Address Id		 Billing Address ID
ship_fname Type:
String		 Title:
Customer First Name		 Shipping First Name to assign to a customer
ship_lname Type:
String		 Title:
Customer Last Name		 Customer Last Name
ship_email Type:
String		 Title:
Shipping Email Address		 Shipping Email Address
ship_comp Type:
String		 Title:
Shipping Company		 Shipping Company
ship_phone Type:
String		 Title:
Shipping Phone Number		 Shipping Phone Number
ship_fax Type:
String		 Title:
Shipping Fax Number		 Shipping Fax Number
ship_addr1 Type:
String		 Title:
Shipping Address 1		 Shipping Address 1
ship_addr2 Type:
String		 Title:
Shipping Address 2		 Shipping Address 2
ship_city Type:
String		 Title:
Shipping City		 Shipping City
ship_state Type:
String		 Title:
Shipping State		 Shipping State. 2 digit state code
ship_zip Type:
String		 Title:
Shipping Zip Code		 Shipping Zip Code
ship_cntry Type:
String		 Title:
Shipping Country		 Shipping Country. 2 digit country code
bill_fname Type:
String		 Title:
Bill Address First Name		 Billing First Name
bill_lname Type:
String		 Title:
Bill Address Last Name		 Customer Last Name
bill_email Type:
String		 Title:
Billing Email Address		 Billing Email Address
bill_comp Type:
String		 Title:
Billing Company		 Billing Company
bill_phone Type:
String		 Title:
Billing Phone Number		 Billing Phone Number
bill_fax Type:
String		 Title:
Billing Fax Number		 Billing Fax Number
bill_addr1 Type:
String		 Title:
Billing Address 1		 Billing Address 1
bill_addr2 Type:
String		 Title:
Billing Address 2		 Billing Address 2
bill_city Type:
String		 Title:
Billing City		 Billing City
bill_state Type:
String		 Title:
Billing State		 Billing State. 2 digit state code
bill_zip Type:
String		 Title:
Billing Zip Code		 Billing Zip Code
bill_cntry Type:
String		 Title:
Billing Country		 Billing Country. 2 digit country code
note_count Type:
Number		 Title:
Note Count		 Number of Notes assigned to customer record
dt_created Type:
Unix Timestamp		 Title:
Date Time Created		 Unix timestamp of the date account was created.
dt_updated Type:
Unix Timestamp		 Title:
Date Time Updated		 Unix timestamp of the date account was last updated.
dt_login Type:
Unix Timestamp		 Title:
Date Time of Last Login		 Date Time of Last Login
credit Type:
Number		 Title:
Customer Account Credit		 Customer Account Credit
formatted_credit Type:
String		 Title:
Formatted Customer Account Credit		 Currency Formatted Customer Account Credit
CustomField_Values Type:
Object		 Title:
Custom Field Value		 Object containing custom field modules
customfield Type:
Object		 Title:
Module Name		 Object containing custom field name value pairs
business_title Type:
String		 Title:
Business Account Title		 Business Account Title/Name

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

Copyright © 1997 – 2023 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.