24/7 Support: 800.608.6482

Navigation


AvailabilityGroupBusinessAccountList_Load_Query

This function loads a list of Business Account availability groups.

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:
Availability Group Business Account List Load Query
The name of the function being executed
assigned Type:
Boolean
Title:
Assigned
Boolean value indicating if the query returns assigned business accounts
availabilitygroup_id Type:
Number
Title:
Availability Group ID
The id number of the availability group
count Type:
Number
Title:
Count
Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort Type:
String
Title:
Sort
The order for sorting returned data
unassigned Type:
Boolean
Title:
Unassigned
Boolean value indicating if the query returns unassigned business accounts

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
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data
id Type:
Number
Title:
ID
customer business account id
title Type:
Number
Title:
Business Title Name
Business name associated with the customer id
tax_exempt Type:
Boolean
Title:
Status Tax Exempt Customer
Boolean value indicating if the customer is tax exempt
order_cnt Type:
Number
Title:
Customer Order Count
The number of orders the customer has placed
order_avg Type:
Number
Title:
Customer Order Average
Average order total for the customer
formatted_order_avg Type:
String
Title:
Currency Formatted Order Average
Currency formatted average order total for the customer
order_tot Type:
Number
Title:
Order Total
Total amount of all orders for the customer
formatted_order_tot Type:
String
Title:
Currency Formatted Order Total
Currency formatted total amount of all orders
note_count Type:
Number
Title:
Note Count
Total number of notes for the customer
assigned Type:
Boolean
Title:
assigned
Boolean value indicating if the customer is currently assigned to the availability group

Example Request

Example Response

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.