24/7 Support: 800.608.6482

Navigation

CustomerAddressList_Load_Query

This function allows you to load a list of addresses associated with a customer account.

Only 1 of the 3 customer identifiers is required. 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
Customer_ID Type:
Number		 Title:
Customer Id		 Customer Id
Customer_Login Type:
String		 Title:
Customer Login		 Customer Login
Edit_Customer Type:
String		 Title:
Edit Customer		 Same value as Customer Login

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
cust_id Type:
Number		 Title:
Customer Id		 Customer Id
descrip Type:
String		 Title:
Address Description		 Example "Work Address" or "Home Address"
fname Type:
String		 Title:
First Name		 First Name
lname Type:
String		 Title:
Last Name		 Last Name
email Type:
String		 Title:
Email Address		 Email Address
comp Type:
String		 Title:
Company		 Company
phone Type:
String		 Title:
Phone Number		 Phone Number
fax Type:
String		 Title:
Fax Number		 Fax Number
addr1 Type:
String		 Title:
Address 1		 Address 1
addr2 Type:
String		 Title:
Address 2		 Address 2
city Type:
String		 Title:
City		 City
state Type:
String		 Title:
State		 State
zip Type:
String		 Title:
Zip Code		 Zip Code
cntry Type:
String		 Title:
Country		 Country
resdentl Type:
Boolean		 Title:
Residental		 Flag for Residental Address (used in shipping rates)

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.