24/7 Support: 800.608.6482

Navigation


Customer_ProductPriceList_Load_Query

This function allows you to load a list of product specific prices for a given customer

See the List Load Functions Overview guide to get started.

Request Body Parameters

count Type:
Number
Title:
Count
Count is used to tell Miva how many records you want returned. If for example you are querying thousands of records 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 above. Use - prefix for a decending sort.
Filter Type:
Object
Title:
Filter
Array of Object containing search filters. See usage here: List Load Query Overview
Function Type:
String
Title:
Function
Always a value of "Module"
Module_Code Type:
String
Title:
Module Code
Always a value of "discount_customerspecific"
Module_Function Type:
String
Title:
Module Function
Always a value of "Customer_ProductPriceList_Load_Query"
Customer_Login Type:
String
Title:
Customer Login
Customer Login
PriceGroup_Name Type:
String
Title:
Price Group Name
Price Group Name
Discounted Type:
Boolean
Title:
Discounted
Flag to only return customers who have a discounted price
Undiscounted Type:
Boolean
Title:
Undiscounted
Flag to only return customers who don't have a discounted price

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
discounted_price Type:
Number
Title:
Discounted Price
Specific Discounted Price for this customer (for the product requested)

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