24/7 Support: 800.608.6482

Navigation

CategoryProductList_Load_Query

This function allows you to load a list of products assigned to a specific category.

Assigned defaults to true and Unassigned defaults to false if omitted. See the List Load Query Overview guide to get started.

Request 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
Category_ID Type:
String		 Title:
Category ID		 Category ID
Category_Code Type:
String		 Title:
Category Code		 Category Code
Edit_Category Type:
String		 Title:
Edit Category		 Edit Category - Same as Category Code
Assigned Type:
Boolean		 Title:
Assigned		 Assigned. Defaults to true if omitted
Unassigned Type:
Boolean		 Title:
Unassigned		 Unassigned. Defaults to false if omitted.

On Demand Columns

descrip Full HTML product description
catcount Number of categories the product is assigned to
productinventorysettings Product specific inventory settings
attributes Includes attribute object in response
productimagedata Product Image including Image Types and non image types
categories Product Category Assignments
productshippingrules Includes product dimensions and restricted shipping methods (if any)
relatedproduct Related product assignments
uris Includes URI's object in response. Canonical URI is the default URL for the product.
CustomField_Values:* See custom field usage here: https://docs.miva.com/json-api/list-load-query-overview

Other custom Filters

Product_Show "All", "Uncategorized" or "Active" (All is default)

Supported Search Filter Columns

code sku cancat_code
page_code name thumbnail
image price cost
weight taxable active
page_title dt_created dt_updated
category Supports only IN and NOT_IN operators. Accepts a comma separated list of category IDs. Limits results to products in the specified categories. product_inventory Searches the product's inventory level (not accounting for baskets)

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.

code sku cancat_code
page_code name thumbnail
image price cost
descrip weight taxable
active page_title dt_created
dt_updated    

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 products 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		 Product Id
code Type:
String		 Title:
Product Code		 Miva Product Code (unique)
Sku Type:
String		 Title:
Product SKU		 Product SKU
thumbnail Type:
String		 Title:
Product Thumbnail		 [Depreciated] This field is depreciated and is supported for legacy purposes. Relative Path to the product thumbnail image.
image Type:
String		 Title:
Product Fullsize Image		 [Depreciated] This field is depreciated and is supported for legacy purposes. Relative Path to the product fullsize image.
price Type:
Number		 Title:
Price		 Product Price
formatted_price Type:
String		 Title:
Formatted_Price		 Currency Formatted Product Price
cost Type:
Number		 Title:
Cost		 Product Cost
formatted_cost Type:
String		 Title:
Formatted_Cost		 Currency Formatted Product Cost
weight Type:
Number		 Title:
Weight		 Product Weight
taxable Type:
Boolean		 Title:
Taxable		 true/false flag if the product is taxable
active Type:
Boolean		 Title:
Active		 true/false flag if the product is active
page_title Type:
String		 Title:
Product Page Title		 Product Page Title - used in HTML title tag within head
dt_created Type:
Unix Timestamp		 Title:
Date/Time Product was created		 Unix timestamp product was created
dt_updated Type:
Unix Timestamp		 Title:
Date/Time Product Updated		 Unix timestamp product was last updated
productinventorysettings
+ Show Properties		 Type:
Object		 Title:
Product Inventory Settings		 productinventorysettings (if requested as an On Demand Column)
active Type:
Boolean		 Title:
Active		 Active Flag if inventory is being tracked on this product
in_short Type:
String		 Title:
Inventory Short Message		 Inventory Short Message
in_long Type:
String		 Title:
Inventory Long Message		 Inventory Long Message
low_track Type:
String		 Title:
Track Low Stock Level		 Values include: d = default (inherits from global), y = yes, n = no
low_level Type:
Number		 Title:
Low Stock Level		 Inventory level at which the low stock level is triggered
low_lvl_d Type:
Boolean		 Title:
Low Stock Level Default		 Flag to determine if low stock level inherits from global settings. Will be set to false if low_level has a value.
low_short Type:
String		 Title:
Low Stock Short Message		 Low Stock Short Message
low_long Type:
String		 Title:
Low Stock Long Message		 Low Stock Long Message
out_track Type:
String		 Title:
Track Out of Stock Level		 Values include: d = default (inherits from global), y = yes, n = no
out_hide Type:
String		 Title:
Hide Out Of Stock Products		 Values include: d = default (inherits from global), y = yes, n = no
out_level Type:
Number		 Title:
Out of Stock Level		 Inventory level at which the out stock level is triggered
out_lvl_d Type:
Boolean		 Title:
Out of Stock Level Default		 Flag to determine if out of stock level inherits from global settings. Will Set to false if out_level has a value.
out_short Type:
String		 Title:
Out of Stock Short Message		 Out of Stock Short Message
out_long Type:
String		 Title:
Out of Stock Long Message		 Out of Stock Long Message
ltd_long Type:
String		 Title:
Limited Stock Message		 Shows when only part of the number requested can be added to the basket. ie. there are only 3 instock but customer tries to add 5.
attributes
+ Show Properties		 Type:
Object		 Title:
Attributes		 Attributes
id Type:
Number		 Title:
Attribute Id		 Attribute Id
product_id Type:
Number		 Title:
Product ID		 Id of product attribute is assigned to
attr_id Type:
Number		 Title:
Attribute Id		 Same as Id field.
default_id Type:
Number		 Title:
Default ID		 id of default attribute option
disp_order Type:
Number		 Title:
Display Order		 Display Order. Used in sorting attributes.
attemp_id Type:
Number		 Title:
Attribute Template Id		 Will contain the id of the attribute id reference, otherwise 0
code Type:
String		 Title:
Attribute Code		 Attribute Code
type Type:
String		 Title:
Attribute Type		 One of the following types: radio, checkbox, text, memo, swatch, swatch-select
prompt Type:
String		 Title:
Attribute Prompt		 Attribute Text displayed to customer during runtime
price Type:
Number		 Title:
Price		 Attribute Price
cost Type:
Number		 Title:
Cost		 Attribute Cost
weight Type:
Number		 Title:
Weight		 Attribute Weight
required Type:
Boolean		 Title:
Required		 Flag if the Attribute is Required
inventory Type:
Boolean		 Title:
Inventory Flag		 Flag if Inventory is being tracked on this attribute. Required when using Inventory Variants.
image Type:
String		 Title:
Attribute Image		 Attribute Image - Relative path to image file.
options
+ Show Properties		 Type:
Object		 Title:
Options		 Options
id Type:
Number		 Title:
Option Id		 Option Id
product_id Type:
Number		 Title:
Product ID		 Id of product attribute is assigned to
attr_id Type:
Number		 Title:
Attribute Id		 Id of attribute option is assigned to
disp_order Type:
Number		 Title:
Display Order		 Display Order. Used in sorting options.
code Type:
String		 Title:
Option Code		 Option Code
prompt Type:
String		 Title:
Option Prompt		 Option Text displayed to customer during runtime
price Type:
Number		 Title:
Price		 Option Price
cost Type:
Number		 Title:
Cost		 Option Cost
weight Type:
Number		 Title:
Weight		 Option Weight
image Type:
String		 Title:
Option Image		 Option Image - Relative path to image file.
productimagedata
+ Show Properties		 Type:
Object		 Title:
Product Image Data		 Product Images
id Type:
Number		 Title:
Image Id		 Image Id
product_id Type:
Number		 Title:
Product ID		 Id of product image is assigned to
image_id Type:
Number		 Title:
Image Id		 Same as Id field.
type_id Type:
Number		 Title:
Type Id		 Image Type Id
code Type:
String		 Title:
Code		 Image Type Code
type_desc Type:
String		 Title:
Image Type Description		 Image Type Description
image Type:
String		 Title:
Image Path		 Relative (to mm5 folder) path to product image
width Type:
Number		 Title:
width		 Width (in Pixels) of image
height Type:
Number		 Title:
Height		 Height (in pixels) of image
disp_order Type:
Number		 Title:
Display Order		 Image Display Order
categories
+ Show Properties		 Type:
Object		 Title:
Categories		 Assigned Categories
id Type:
Number		 Title:
Category Id		 Category Id
parent_id Type:
Number		 Title:
Parent ID		 Id of parent category. 0 if category does not have a parent
agrpcount Type:
Number		 Title:
Availability Group Count		 Availability Group Count
depth Type:
Number		 Title:
Depth		 Category Depth
disp_order Type:
Number		 Title:
Display Order		 Category Display Order
page_id Type:
Number		 Title:
Page Id		 Alternate Display Page Id. O if none.
code Type:
String		 Title:
Code		 Category Code
name Type:
String		 Title:
Category Name		 Category Name
page_title Type:
String		 Title:
Page Title		 Page Title Tag (used in head tag)
active Type:
Boolean		 Title:
Active		 Active
dt_created Type:
Unix Timestamp		 Title:
Date/Time Created		 Date/Time Created
dt_updated Type:
Unix Timestamp		 Title:
Date/Time Updated		 Date/Time Updated
uris
+ Show Properties		 Type:
Object		 Title:
URIs		 URIs
id Type:
Number		 Title:
URI Id		 URI Id
uri Type:
String		 Title:
Uri		 relative URI path to product
store_id Type:
Number		 Title:
Store ID		 Id of Store product URI is assigned to
screen Type:
String		 Title:
Screen		 Only used for page uris. Will always be empty for product URIs
page_id Type:
Number		 Title:
Page Id		 Only used for page uris. Will always be 0 for product URIs
cat_id Type:
Number		 Title:
Category Id		 Category Id URI is associated with
product_id Type:
Number		 Title:
Product Id		 Product Id URI is associated with
feed_id Type:
Number		 Title:
feed_id		 Feed id URI is associated with
canonical Type:
Boolean		 Title:
Canonical		 Flag to signifiy if URI is the canonical (default) URI
status Type:
Number		 Title:
Status		 http Status to return. Values include: 200, 301, 302, 303, 307
concact_code Type:
String		 Title:
Canonocal Category Code		 Canonical Category Code for the product
page_code Type:
String		 Title:
Alternate Display Page Code		 Will contain the page code if the product is linked to an alternate display page (other than PROD)
product_inventory_active Type:
Boolean		 Title:
Product Inventory Active		 Flag if inventory is being tracked on this product
product_inventory Type:
Number		 Title:
Product Inventory Count		 Current Inventory Count
CustomField_Values
+ Show Properties		 Type:
Object		 Title:
Custom Field Values		 Object of Custom Fields
cmp-cssui-pchdft
+ Show Properties		 Type:
Object		 Title:
Product/Category Header & Footer		 Product/Category Header & Footer
header Type:
String		 Title:
Product Header		 Full HTML of Product Header
footer Type:
String		 Title:
Product Footer		 Full HTML of Product Footer

Example Request

Example Response

Error Responses

error code
MER-JSN-CAT-00033		 error message
Unable to load category: One of Category_ID, Edit_Category or Category_Code must be specified		   Missing required category identifier

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.