24/7 Support: 800.608.6482

Navigation


PriceGroupBusinessAccountList_Load_Query

This function loads a list of Business Account price 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:
Price Group Business Account List Load Query
The name of the function being executed
pricegroup_id Type:
Number
Title:
Price Group ID
The id number of the price group
assigned Type:
Boolean
Title:
Assigned
Boolean value indicating if the query returns assigned business accounts
unassigned Type:
Boolean
Title:
Unassigned
Boolean value indicating if the query returns unassigned business accounts
Filter Type:
String
Title:
Filter
A string for filtering returned data
sort Type:
String
Title:
Sort
The order for sorting returned data
offset Type:
Number
Title:
Offset
Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
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

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
business account id
title Type:
Number
Title:
Business Title Name
Business name associated with the id
tax_exempt Type:
Boolean
Title:
Status Tax Exempt Business
Boolean value indicating if the business 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 price group

Example Request

Example Response

Error Responses

error code:
MER-PGR-JSN-00006
error message:
Price group not found
description:
Price group not found

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 – 2022 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.