24/7 Support: 800.608.6482

Navigation

BusinessAccountCustomerList_Load_Query

This function loads a list of customers from a business account.

Request Parameters

Store_Code Type:
String		 Title:
Store Code		 Store code to run the function against. Found in the Miva Admin under Settings > Store Details
Function Type:
String		 Title:
Business Account Customer List Load Query		 The name of the function being executed
BusinessAccount_ID Type:
Number		 Title:
Business Account ID		 The business id
Assigned Type:
String		 Title:
Assigned		 String indicating if assigned customers be returned
Count Type:
Number		 Title:
Count		 Maximum number of customers to be returned
Filter Type:
String		 Title:
Filter		 Search string for filtering customer name
Offset Type:
Number		 Title:
Offset		 the offset starting point for pagination of return data
Sort Type:
String		 Title:
Sort		 The sort order for returned data
Unassigned Type:
String		 Title:
Unassigned		 String indicating if unassigned customers be returned

Response Parameters

success Type:
Boolean		 Title:
Status Response		 Boolean value indicating if the api request was successful
total_count Type:
Number		 Title:
Total Count		 The number of customers returned for the business account
start_offset Type:
Number		 Title:
Start Offset		 the offset starting point for pagination of return data
id Type:
Number		 Title:
id		 The customer id
account_id Type:
Number		 Title:
Account ID		 The account id for the customer
login Type:
String		 Title:
Login		 Customer login name
pw_email Type:
String		 Title:
Password Email		 Customer email for password
ship_id Type:
Number		 Title:
Shipping ID		 The shipping id for the customer
ship_res Type:
Boolean		 Title:
Residential Shipping		 Boolean value indicating if the shipping address is residential
ship_fname Type:
String		 Title:
Shipping First Name		 Customer shipping first name
ship_lname Type:
String		 Title:
Shipping Last Name		 Customer shipping last name
ship_email Type:
String		 Title:
Shipping Email		 Email address for shipping
ship_comp Type:
String		 Title:
Shipping Company Name		 Company name for shipping
ship_phone Type:
String		 Title:
Shipping Phone Number		 Phone number for shipping
ship_fax Type:
String		 Title:
Shipping Fax Number		 Fax number for shipping
ship_addr1 Type:
String		 Title:
Shipping Address Field 1		 First field for shipping address
ship_addr2 Type:
String		 Title:
Shipping Address Field 2		 Second field for shipping address
ship_city Type:
String		 Title:
Shipping City		 City for shipping
ship_state Type:
String		 Title:
Shipping State		 State for shipping
ship_zip Type:
String		 Title:
Shipping Zip Code		 Zip code for shipping
ship_cntry Type:
String		 Title:
Shipping Country		 Country for shipping
bill_id Type:
Number		 Title:
Customer Billing ID		 The billing id for the customer
bill_fname Type:
String		 Title:
Billing First Name		 First name for billing
bill_lname Type:
String		 Title:
Billing Last Name		 Last name for billing
bill_email Type:
String		 Title:
Billing Email		 Email address for billing
bill_comp Type:
String		 Title:
Billing Company Name		 Company Name for billing
bill_phone Type:
String		 Title:
Billing Phone Number		 Phone number for billing
bill_fax Type:
String		 Title:
Billing Fax Number		 Fax number for billing
bill_addr1 Type:
String		 Title:
Billing Address Field 1		 First field for billing address
bill_addr2 Type:
String		 Title:
Billing Address Field 2		 Second field for billing address
bill_city Type:
String		 Title:
Billing City		 City for billing
bill_state Type:
String		 Title:
Billing State		 State for billing
bill_zip Type:
String		 Title:
Billing Zip Code		 Zip code for billing
bill_cntry Type:
String		 Title:
Billing Country		 Country for billing
tax_exempt Type:
Boolean		 Title:
Tax Exempt		 Boolean value indicating if the customer is tax exempt
order_cnt Type:
Number		 Title:
Order Count		 Number of orders placed by the customer
order_avg Type:
Number		 Title:
Order Average		 Average order value for the customer
formatted_order_avg Type:
String		 Title:
Currency Formatted Order Average		 Currency formatted average order value for the customer
order_tot Type:
Number		 Title:
Order Total		 Total order value for the customer
formatted_order_tot Type:
String		 Title:
Currency Formatted Order Total		 Currency formatted total order value for the customer
note_count Type:
Number		 Title:
Note Count		 Number of notes associated with the customer
dt_created Type:
Number		 Title:
Customer Creation Date		 Unix timestamp for the date the customer was created
dt_login Type:
Number		 Title:
Date of Customer Login		 Unix timestamp for the last customer login date
dt_pwchg Type:
Number		 Title:
Date of Password Change		 Unix timestamp for the last password change
credit Type:
Number		 Title:
Customer Credit		 Total credit for the customer
formatted_credit Type:
String		 Title:
Currency Formatted Customer Credit		 Currency formatted total credit for the customer
assigned Type:
Boolean		 Title:
assigned		 Boolean value indicating if the customer is assigned to an employee
business_title Type:
String		 Title:
Business Title		 Business title for the customer

Example Request

Example Response

Error Responses

error code:
MER-JSN-00024		 error message:
Missing required parameter Function		 description:
Missing required parameter Function
error code:
MER-CUS-JSN-00019		 error message:
Business account not found		 description:
Business account not found by ID

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.