24/7 Support: 800.608.6482

Navigation

ChildCategoryList_Load_Query

This function loads a list of child categories from a specified parent category.

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:
Child Category List Load Query		 The name of the function being executed
ParentCategory_ID Type:
Number		 Title:
Parent Category ID		 Parent category id for the child category
Filter Type:
String		 Title:
Filter		 Search string for filtering the category name
Sort Type:
String		 Title:
Sort		 The sort order for returned data
Offset Type:
Number		 Title:
Offset		 The offset starting point for pagination of return data
Count Type:
Number		 Title:
Count		 Maximum number of child categories to be returned
Assigned Type:
Boolean		 Title:
Assigned		 Boolean value indicating if assigned child categories should be returned
Unassigned Type:
Boolean		 Title:
Unassigned		 Boolean value indicating if unassigned child categories should be returned

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

Example Request

Example Response

Error Responses

error code:
MER-JSN-CAT-00038		 error message:
Parent category not found		 description:
Parent category not found by ID

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