PriceGroupProductList_Load_Query

This function allows you to look up products assigned to a specific price group. It follows the same structure as other List Load Functions in Miva.

Request Parameters

count	Type: Number	Title: Count	Count is used to tell Miva how many price groups you want returned. 0 will return all price groups.
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.
Assigned	Type: Boolean	Title: Assigned	True/False to return assigned or unassigned products
Unassigned	Type: Boolean	Title: Unassigned	True/False to return assigned or unassigned products
PriceGroup_ID	Type: Number	Title: Price Group Id	Price Group Id
PriceGroup_Name	Type: String	Title: Price Group Name	Price Group Name
Filter	Type: Object	Title: Filter	Array of Object containing search filters. See usage here: List Load Query Overview

On Demand Columns

The same ondemand columns as ProductList_Load_Query are supported

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

Supported Search Filter Columns

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

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
cancat_code	Type: String	Title: Canonical Category Code	Canonical Category Code
page_code	Type: String	Title: Page Code	Alternate Page Code
product_inventory_active	Type: Boolean	Title: Product Inventory Active	Product Inventory Active
product_inventory	Type: Number	Title: Product Inventory Count	Product Inventory Count
assigned	Type: Boolean	Title: Assigned	true/false if the product is assigned to the price group