24/7 Support: 800.608.6482

Get Started

Navigation


CategoryList_Load_Query

This function allows you to query one or more categories from Miva

See the List Load Query Overview guide to get started.

On Demand Columns

CustomField_Values:*  

Other Filter Columns

Category_Show "All", "Active" (All is default)

Search Filter Columns

Name Depth Code
Alternate Display Page Parent Category Page title
Created Last Updated  

Supported Sort Columns

Code Name Active
Parent Category Page title Last Updated
Depth Alternate Display Page Created

Request Body Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many categories you want returned. If for example you are querying thousands of categories 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

Response Parameters

Success Type:
Number
Title:
Success
Success
Total Count Type:
Number
Title:
Total Count
Total Count
Start_offset Type:
Number
Title:
Start_offset
Start_offset
id Type:
Number
Title:
Category Id
Category Id
parent_id Type:
Number
Title:
Parent Id
Id of the categories parent category
agrpcount Type:
Number
Title:
Availability Group Count
Number of availability groups the category is assigned to
depth Type:
Number
Title:
Depth
Depth
disp_order Type:
Number
Title:
Display Order
Display Order
page_id Type:
Number
Title:
Page Id
Id of auternate page display. 0 if none
code Type:
String
Title:
Category Code
Category Code
name Type:
String
Title:
Category Name
Category Name
page_title Type:
String
Title:
Page Title
Page Title
active Type:
Boolean
Title:
Active
Active Flag
dt_created Type:
Unix Timestamp
Title:
Date/Time Created
Created Date
dt_updated Type:
Unix Timestamp
Title:
Date/Time Updated
Last Updated
page_code Type:
String
Title:
Page Code
Alternate Page Display Code
parent_category Type:
String
Title:
Parent Category
Parent Category. Empty if no parent
CustomField_Values
+ Show Properties
Type:
Object
Title:
Custom Field Values
Object of Custom Fields
cmp-mv-prodctgy-meta
+ Show Properties
Type:
Object
Title:
Product/Category Header & Footer
Category Meta Fields
keywords Type:
String
Title:
Category Meta Keywords
Category Meta Keywords
description Type:
String
Title:
Category Meta Description
Category Meta Description

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