24/7 Support: 800.608.6482

Navigation


BusinessAccountList_Load_Query

This function loads a list of business accounts.

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 List Load Query
The name of the function being executed

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 business accounts returned for the product
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data
id Type:
Number
Title:
ID
The business id
title Type:
String
Title:
Title
The business name
tax_exempt Type:
Boolean
Title:
Tax Exempt
Boolean value indicating if the business is tax exempt
order_cnt Type:
Number
Title:
Order Count
Number of orders placed by the business
order_avg Type:
Number
Title:
Order Average
Average order value for the business
formatted_order_avg Type:
String
Title:
Currency Formatted Order Average
Currency formatted average order value for the business
order_tot Type:
Number
Title:
Order Total
Total order value for the business
formatted_order_tot Type:
String
Title:
Currency Formatted Order Total
Currency formatted total order value for the business
note_count Type:
Number
Title:
Note Count
Number of notes associated with the business account

Example Request

Example Response

Error Responses

error code:
MER-JSN-00024
error message:
Missing required parameter Function
description:
Missing required parameter Function

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.