URIList_Load_Query

This function is used to query one or more URIs from Miva.

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

On Demand Columns

uris	Includes URI object in response. Canonical URI is the default URL for the product.
screen	Includes Screen in response. Canonical URI is the default URL for the product.
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
subscriptionsettings	Subscription Settings - Added in 10.06.00
subscriptionterms	Subscription Terms - Added in 10.06.00
url	Returns the full URL path, including domain name.
CustomField_Values:*	See custom field usage here: https://docs.miva.com/json-api/list-load-query-overview
product_inventory	Includes 2 new fields for inventory counts as well as if inventory is active
page_code	Includes page_code field associated with product in response. Page_Code is used for alternate Product page templates.
cancat_code	Includes cancat_code field associated with product in response. cancat_code is the canonical category code for the product.

Supported Search Filter Columns

type	URI	Store
Screen	Page Code	Category Code
Category Name	Product Code	Product SKU
Product Name	Feed Code	Feed Name

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.

type	URI	Store
Screen	Page Code	Category Code
Category Name	Product Code	Product SKU
Product Name	Feed Code	Feed Name

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
uri	Type: String	Title: URI	URI (unique)
store_id	Type: Number	Title: Store ID	Store ID
Screen	Type: String	Title: Screen	Screen
page_code	Type: String	Title: Page Code	Page Code
cat_id	Type: Number	Title: Category ID	Category ID
product_id	Type: Number	Title: Product ID	Product ID
feed_id	Type: Number	Title: Feed ID	Feed ID
canonical	Type: Boolean	Title: Canonical	Canonical URI
status	Type: Number	Title: Status	URI Status
store + Show Properties	Type: Object	Title: Store Information	Store Information

code	Type: String	Title: Store Code	Store Code
Name	Type: String	Title: Store Name	Store Name

Example Requests

Request containing a search filter (return only active products)