24/7 Support: 800.608.6482

Navigation

CustomerPriceGroupList_Load_Query

This function allows you to load a list of price groups assigned (or not assigned) to a customer

Only 1 of the 3 customer identifiers is required. See the List Load Query Overview guide to get started.

Request Body Parameters

count Type:
Number		 Title:
Count		 Count is used to tell Miva how many customers you want returned. If for example you are querying thousands of customers 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
Customer_ID Type:
Number		 Title:
Customer Id		 Customer Id
Customer_Login Type:
String		 Title:
Customer Login		 Customer Login
Edit_Customer Type:
String		 Title:
Edit Customer		 Same value as Customer Login
Assigned Type:
Boolean		 Title:
Assigned		 Assigned
Unassigned Type:
Boolean		 Title:
Unassigned		 Unassigned

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
+ Show Properties		 Type:
Object		 Title:
dt_start		 Prior to 10.05.00 this value was a Unix Timestamp. 10.05.00 and beyond an Object is returned.
time_t Type:
Unix Timestamp		 Title:
Time T		 Start Time as a Unix Timestamp
year Type:
Number		 Title:
Year		 Year
month Type:
Number		 Title:
Month		 Month
day Type:
Number		 Title:
Day		 Day of week represented as a integer
hour Type:
Number		 Title:
Hour		 Hour
minute Type:
Number		 Title:
Minute		 Minute
second Type:
Number		 Title:
Second		 Second
timezone Type:
Number		 Title:
Timezone		 Number of hours before or after GMT
dt_end
+ Show Properties		 Type:
Object		 Title:
dt_end		 End Time. 0 is no end time. Prior to 10.05.00 this value was a Unix Timestamp. 10.05.00 and beyond an Object is returned.
time_t Type:
Unix Timestamp		 Title:
Time T		 Start Time as a Unix Timestamp
year Type:
Number		 Title:
Year		 Year
month Type:
Number		 Title:
Month		 Month
day Type:
Number		 Title:
Day		 Day of week represented as a integer
hour Type:
Number		 Title:
Hour		 Hour
minute Type:
Number		 Title:
Minute		 Minute
second Type:
Number		 Title:
Second		 Second
timezone Type:
Number		 Title:
Timezone		 Number of hours before or after GMT
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
assigned Type:
Boolean		 Title:
Assigned		 true/false if customer is assigned to Price Group

Example Request

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