24/7 Support: 800.608.6482

Navigation


Runtime_ProductList_Load_Query

This is a runtime function intended to be called client side to query product data. Because this is a runtime (public) function no API key is required. This function has ondemandcolumns to optionally retrieve inventory, attribute and options, discounts, sale price, and default category. In addition, there are optional filters to return images including dynamically requesting image sizes that may not exist yet.

Request Parameters

session_type Type:
String
Title:
Session Type
This will always have a hard-coded value of "runtime." This tells Miva, no authentication is needed for the API call.
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:
Number
Title:
Offset
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
Session_ID Type:
String
Title:
Basket Session ID
[Optional] Passing the Session_ID in the request will allow any customer-specific discounts get applied.

On Demand Columns

descrip Full HTML product description
inventory Inventory count and inventory settings
attributes Product attributes and options
sale_price Discounted sale price for the product. When sale_price is requested, the price standard field will be overwritten with the sale price value.
discounts Any discounts applied to the product creating the sale_price
category Canonical category for each product. This is determined, first by the canonical category, if specified, and second, the first category to which the product is assigned.
CustomField_Values:* See custom field usage here: https://docs.miva.com/json-api/list-load-query-overview

Other Custom Filters

imagetypes This filter may be specified more than once. Each instance of the filter may request different sizes. If "sizes" is not specified, only the original image is returned. Requested sizes that do not exist will be generated.
images This filter returns all of the images assigned to a product, regardless of image type. Any sizes passed will be generated/returned for all images.
runtime_search Performs a runtime search against the products (same as if the customer used the search box on the site). Only the columns included in the response are searchable. Inventory and attributes are not searched.

Supported Sort Columns

One of these values would be passed in the sort request parameter to have the results sorted by that column.

relevance customfield/customfield_desc disp_order/disp_order_desc
newest oldest updated
code_asc code_desc name_asc
name_desc price_asc price_desc
bestsellers

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 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
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.
thumbnail Type:
String
Title:
Product Thumbnail
[Depreciated] This field is depreciated and is supported for legacy purposes. Relative Path to the product thumbnail image.
disp_order Type:
Number
Title:
Display Order
Product Display Order
output_disp_order Type:
Number
Title:
Output Display Order
Output Product Display Order
dt_created
+ Show Properties
Type:
Object
Title:
Date/Time Created
Date Time Stamp the product was created
time_t Type:
Unix Timestamp
Title:
Unix Timestamp for date created
Unix Timestamp for date created
year Type:
Number
Title:
Year
Year
month Type:
Number
Title:
Month
Month
day Type:
Number
Title:
Day
Day
hour Type:
Number
Title:
Hour
Hour
minute Type:
Number
Title:
Minute
Minute
second Type:
Number
Title:
Second
Second
timezone Type:
Number
Title:
TImezone
Offset from UTC
dt_updated
+ Show Properties
Type:
Object
Title:
Date/Time Updated
Date Time Stamp the product was last updated
time_t Type:
Unix Timestamp
Title:
Unix Timestamp for date updated
Unix Timestamp for date updated
year Type:
Number
Title:
Year
Year
month Type:
Number
Title:
Month
Month
day Type:
Number
Title:
Day
Day
hour Type:
Number
Title:
Hour
Hour
minute Type:
Number
Title:
Minute
Minute
second Type:
Number
Title:
Second
Second
timezone Type:
Number
Title:
TImezone
Offset from UTC
weight Type:
Number
Title:
Weight
Product Weight
taxable Type:
Boolean
Title:
Taxable
true/false flag if the product is taxable
price Type:
Number
Title:
Price
Product Price
formatted_price Type:
String
Title:
Formatted_Price
Currency-Formatted Product Price
retail Type:
Number
Title:
Retail Price
Retail price before any discounts have been applied
formatted_retail Type:
String
Title:
Formatted Retail
Currency-Formatted Retial Price
base_price Type:
Number
Title:
Base Price
Includes any legacy price group discounts but does not reflect sales, coupons or discounts applied in the basket
formatted_base_price Type:
String
Title:
Formatted Base Price
Includes any legacy price group discounts but does not reflect sales, coupons or discounts applied in the basket
quantity Type:
Number
Title:
Quantity
Quantity
url Type:
String
Title:
URL
Canonical URL to the product
descrip Type:
String
Title:
Description
[ondemandcolumn] Only output if "descrip" is passed as an ondemandcolumn. Full HTML description.
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
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.
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
attemp_id Type:
Number
Title:
Attribute Template Id
Will contain the id of the attribute id reference, otherwise 0
prompt Type:
String
Title:
Attribute Prompt
Attribute Text displayed to customer during runtime
price Type:
Number
Title:
Price
Attribute Price
formatted_price Type:
String
Title:
Formatted Price
Currency Formatted Attribute Price
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
formatted_price Type:
String
Title:
Formatted Price
Currency Formatted Option Price
weight Type:
Number
Title:
Weight
Option Weight
image Type:
String
Title:
Option Image
Option Image - Relative path to image file.
sale_price Type:
Number
Title:
Sale Price
[Ondemandcolumn] Sale Price with discounts applied. If you want customer-specific prices the Sesssion_ID should also be passed in the request
inv_active Type:
Boolean
Title:
Inventory Active
[Ondemandcolumn] Boolean flag for Inventory Active for this product
inv_level Type:
String
Title:
Inventory Level
[Ondemandcolumn] One of In Stock, Low Stock, Out of Stock
inv_available Type:
Number
Title:
Inventory Available
[Ondemandcolumn] Inventory Available
inv_available Type:
Number
Title:
Inventory Available
[Ondemandcolumn] Inventory Available. This is the instock amount - threshold you have set for out of stock level (default is 0)
inv_instock Type:
Number
Title:
Inventory Instock
[Ondemandcolumn] Inventory In Stock
inv_short Type:
String
Title:
Inventory Short Message
[Ondemandcolumn] Inventory Short Message
inv_long Type:
String
Title:
Inventory Long Message
[Ondemandcolumn] Inventory Long Message
page
+ Show Properties
Type:
Object
Title:
Page
[ondemandcolumn] Page Template
id Type:
Number
Title:
Page Id
Page Id for template controling product (default template is PROD)
code Type:
String
Title:
Page Code
Page Code for template controling product. (default template is PROD)
title Type:
String
Title:
Page Title
Title of Page Template
category
+ Show Properties
Type:
Object
Title:
Canonical Category
[ondemandcolumn] Canonical Category Product is Assigned To
id Type:
Number
Title:
Category Id
Category Id
code Type:
String
Title:
Code
Category Code
name Type:
String
Title:
Category Name
Category Name
url Type:
url
Title:
String
Url to Canonical Category. This is determined by 1. Canonical category, if specified 2. First category to which the product is assigned.
discounts
+ Show Properties
Type:
Object
Title:
Discounts
[ondemandcolumn] Discounts
descrip Type:
String
Title:
Discount Description
Discount Description
discount Type:
Number
Title:
Discount Amount
Discount Amount
formatted_discount Type:
String
Title:
Formatted Discount
Currency-Formatted Discount Amount
images
+ Show Properties
Type:
Object
Title:
Images
[ondemandcolumn] Images
code Type:
String
Title:
Image Type Code
[optional] Image Type Code, if assigned
descrip Type:
String
Title:
Image Type Description
Image Type Description
sizes
+ Show Properties
Type:
Object
Title:
Image Sizes
Sizes will have child objects with the name width of the images. Ie. 50x50, 100x100. Original is the non-resized image
url Type:
String
Title:
URL to Image
Full URL to Image
width Type:
Number
Title:
Image Width
Image Width
height Type:
Number
Title:
Image Height
Image Height
imagetypes
+ Show Properties
Type:
Object
Title:
Images Types
[ondemandcolumn] Request Images By Image Types. Contains child objects with the image type name.
descrip Type:
String
Title:
Description
Image Type Description
sizes
+ Show Properties
Type:
Object
Title:
Image Sizes
Sizes will have child objects with the name width of the images. Ie. 50x50, 100x100. Original is the non-resized image
url Type:
String
Title:
URL to Image
Full URL to Image
width Type:
Number
Title:
Image Width
Image Width
height Type:
Number
Title:
Image Height
Image Height
discounts
+ Show Properties
Type:
Object
Title:
Discounts
[ondemandcolumn] Discounts
descrip Type:
String
Title:
Discount Description
Discount Description
discount Type:
Number
Title:
Discount Amount
Discount Amount
formatted_discount Type:
String
Title:
Formatted Discount
CUrrency Formatted Discount Amount
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 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 – 2022 Miva©, Miva Merchant©, MivaPay©, MivaCon©, Camp Miva ℠, Miva, Inc. All Rights Reserved.