24/7 Support: 800.608.6482

Get Started

Navigation


AvailabilityGroupList_Load_Query

This function is used to query one or more availability groups from miva. It follows the same structure as other List Load Functions in Miva.

Request Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many availability groups you want returned. 0 will return all availability groups.
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

On Demand Columns

This function has no ondemandcolumns.

Supported Search Filter Columns

id name  

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 name  

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 price groups 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 products to return. Used in conjunction with the Count parameter for paginating results of large datasets.
id Type:
Number
Title:
id
Availability Group Id
name Type:
String
Title:
Name
Availability Group Name

Example Requests

Example Response

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