24/7 Support: 800.608.6482

Navigation


AvailabilityGroupCategoryList_Load_Query

This function loads a list of product categories by Availability Group.

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 Category List Load Query
The name of the function being executed
assigned Type:
Boolean
Title:
Assigned
Boolean value indicating if the query returns assigned categories
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
filter Type:
String
Title:
Filter
A string for filtering returned data
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 categories

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 categories returned
start_offset Type:
Number
Title:
Start Offset
the offset starting point for pagination of return data
id Type:
Number
Title:
Category ID
customer id
parent_id Type:
Number
Title:
Parent ID
parent category id associated with the category
agrpcount Type:
Number
Title:
Availability Group Count
the number of availability groups the category is assigned to
depth Type:
Number
Title:
Depth
the number of parent categories
disp_order Type:
Number
Title:
Display Order
the display order position for the category
page_id Type:
Number
Title:
Page ID
page id associated with the category
code Type:
String
Title:
Category Code
The category code
name Type:
String
Title:
Category Name
The category name
page_title Type:
Number
Title:
Page Title
The page title for the category
active Type:
Boolean
Title:
Category Active
Boolean value indicating if the category is active
dt_created Type:
Number
Title:
Category Creation Date
Unix timestamp for the category creation date
dt_updated Type:
Number
Title:
Category Updated Date
Unix timestamp for the date the category was updated
page_code Type:
String
Title:
Category Page Code
The page code of the category
parent_category Type:
String
Title:
Parent Category
The parent category for the category
assigned Type:
Boolean
Title:
Category Assigned
Boolean value indicating if the category is assigned

Example Request

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