24/7 Support: 800.608.6482

Navigation

CouponBusinessAccountList_Load_Query

This function allows you to load one or more business accounts assigned to a coupon.

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 products you returned. If for example you are querying thousands of products 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
Coupon_Code Type:
String		 Title:
Coupon Code		 Value of Coupon Code
Coupon_ID Type:
Number		 Title:
Coupon ID		 Value of Coupon ID

Search Filter Columns

title note_count tax_exempt
order_cnt order_avg order_tot

Supported Sort Columns

One of these values would be passed in the sort request parameter to have the results sorted by that column. Value may be preceded by "-" for a descending sort.

id title note_count
tax_exempt order_cnt order_avg
order_tot max_per active

Response Parameters

total_count Type:
Number		 Title:
Total Product Count		 total_count is the total number of records that match your search criteria. Note: this is not always the total coupons 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 coupons to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id Type:
Number		 Title:
id		 Business Account Id
title Type:
String		 Title:
Business Account Title		 Business Account Title
order_cnt Type:
Number		 Title:
Order Count		 Total orders by business account
order_avg Type:
Number		 Title:
Order Average		 Average value of orders by the business account
formatted_order_avg Type:
Number		 Title:
Formatted Order Average		 Formatted average value of orders by the business account
order_tot Type:
Number		 Title:
Order Total		 Total number of orders by the business account
formatted_order_tot Type:
Number		 Title:
Formatted Order Total		 Formatted order total of orders by the business account
note_count Type:
Number		 Title:
Note Count		 Note count for business account
assigned Type:
Boolean		 Title:
Assigned		 Assigned to coupon

Example Request

Example Response

Copyright © 1997 – 2025 Miva®, Miva Merchant®, MivaPay®, MivaCon®, Camp Miva®, Miva Connect®, Miva, Inc. All Rights Reserved.