24/7 Support: 800.608.6482

Get Started

Navigation


PriceGroupList_Load_Query

This function is used to query one or more price groups from miva. 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.
Filter Type:
Object
Title:
Filter
Array of Object containing search filters. See usage here: List Load Query Overview

On Demand Columns

This function has no ondemandcolumns.

Supported Search Filter Columns

id name module_id
custscope rate discount
markup dt_start dt_end
priority exclusion descrip
display qmn_subtot qmx_subtot
qmn_quan qmx_quan qmn_weight
qmx_weight bmn_subtot bmx_subtot
bmn_quan bmx_quan bmn_weight
bmx_weight    

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.

id name type
module_id custscope rate
discount markup dt_start
dt_end priority exclusion
descrip display qualifying_subtotal
qualifying_quantity qualifying_weight basket_quantity
basket_subtotal basket_weight  

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 price groups 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
Price Group Id
name Type:
String
Title:
Name
Price Group Name
custscope Type:
String
Title:
Customer Scope
One of the following values: C = Coupon Only, X = Specific Customers, L = All Logged-in Customers, A = All Shoppers
rate Type:
String
Title:
Rate
Used in Legacy Price Group to determine disccount type: R = Retail, C = Cost, D = Discount from Retail, M = Markup from cost.
discount Type:
Number
Title:
Discount
Legacy Price Group Discount
markup Type:
Number
Title:
Markup
Legacy Price Group Markup
dt_start Type:
Unix Timestamp
Title:
Start Time
Start Time
dt_end Type:
Unix Timestamp
Title:
End Time
End Time. 0 is no end time.
qmn_subtot Type:
Number
Title:
Qualifying Product Minimum Subtotal
Qualifying Product Minimum Subtotal
qmx_subtot Type:
Number
Title:
Qualifying Product Maximum Subtotal
Qualifying Product Maximum Subtotal
qmn_quan Type:
Number
Title:
Qualifying Product Minimum Quantity
Qualifying Product Minimum Quantity
qmx_quan Type:
Number
Title:
Qualifying Product Maximum Quantity
Qualifying Product Maximum Subtotal
qmn_weight Type:
Number
Title:
Qualifying Product Minimum Weight
Qualifying Product Minimum Weight
qmx_weight Type:
Number
Title:
Qualifying Product Maximum Weight
Qualifying Product Maximum Weight
bmn_subtot Type:
Number
Title:
Basket Minimum Subtotal
Basket Minimum Subtotal
bmx_subtot Type:
Number
Title:
Basket Maximum Subtotal
Basket Maximum Subtotal
bmn_quan Type:
Number
Title:
Basket Minimum Quantity
Basket Minimum Quantity
bmx_quan Type:
Number
Title:
Basket Maximum Quantity
Basket Maximum Subtotal
bmn_weight Type:
Number
Title:
Basket Minimum Weight
Basket Minimum Weight
bmx_weight Type:
Number
Title:
Basket Maximum Weight
Basket Maximum Weight
prority Type:
Number
Title:
Priotity
Used for order in which price groups are applied
module
+ Show Properties
Type:
Object
Title:
Module
Discount Module Use for Price Group
id Type:
Number
Title:
Discount Module Id
Discount Module Id
code Type:
String
Title:
Code
Module Code
name Type:
String
Title:
Name
Module Name
provider Type:
String
Title:
Provider
Developer who created the discount module
api_ver Type:
Number
Title:
API Version
Miva API Version the Module is using
module Type:
String
Title:
Module Path
Relative path to the module file on the server
refcount Type:
Number
Title:
Reference Count
Number of Price Groups which are using this disocunt module
active Type:
Number
Title:
Active
Active
Capabilities
+ Show Properties
Type:
Object
Title:
Capabilities
Capabilities Object
preitems Type:
String
Title:
Pre Items
If true, the module implements theDiscountModule_Discount_PreItems function
items Type:
Boolean
Title:
Items
If true, the module supports discounts to individual items and must implement the DiscountModule_Discount_Items function
eligibility Type:
String
Title:
Eligibility
Controls Admin UI
basket Type:
Boolean
Title:
Basket
If true, the module supports discounts to the overall basket and must implement the DiscountModule_Discount_Basket function
shipping Type:
Boolean
Title:
Shipping
If true, the module supports discounts to shipping methods and must implement both the DiscountModule_Discount_Shipping and the DiscountModule_Discount_ShippingMethodList functions
qualifying Type:
Boolean
Title:
Qualifying
Qualifying
exclusion Type:
Boolean
Title:
Exclusion
Exclusion
descrip Type:
String
Title:
Description
Custom Basket Description Override
display Type:
Boolean
Title:
Display
Boolean to display discount description in basket

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