Skip to content

`Customer_ProductPriceList_Load_Query`#

Description#

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

Request Body Parameters#

Parameter	Type	Description
`count`	Number	Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
`filter`	String	A string for filtering returned data
`offset`	Number	Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
`sort`	String	The order for sorting returned data
`Function`	String	Always a value of “Module”.
`Module_Code`	String	Always a value of “discount_customerspecific”.
`Module_Function`	String	Always a value of “Customer_ProductPriceList_Load_Query”.
`Customer_Login`	String	Customer Login.
`PriceGroup_Name`	String	Price Group Name.
`Discounted`	Boolean	Flag to only return customers who have a discounted price.
`Undiscounted`	Boolean	Flag to only return customers who don’t have a discounted price.

Response Parameters#

Parameter	Type	Description
`total_count`	Number	Total number of records that match your search criteria.
`start_offset`	Number	Number of the starting offset of products to return.
`id`	Number	Product Id
`code`	String	Miva Product Code (unique)
`Sku`	String	Product SKU
`thumbnail`	String	Relative Path to the product thumbnail image.
`image`	String	Relative Path to the product full-size image.
`price`	Number	Product Price
`formatted_price`	String	Currency Formatted Product Price
`cost`	Number	Product Cost
`formatted_cost`	String	Currency Formatted Product Cost
`weight`	Number	Product Weight
`taxable`	Boolean	True/false flag if the product is taxable
`active`	Boolean	True/false flag if the product is active
`page_title`	String	Product Page Title - used in HTML title tag within head
`dt_created`	Unix TS	Unix timestamp product was created
`dt_Updated`	Unix TS	Unix timestamp product was last updated
`discounted_price`	Number	Specific Discounted Price for this customer (for the product requested)

Example Request#

{
    "Store_code": "beta",
    "Function": "Module",
    "Module_Code": "discount_customerspecific",
    "Module_Function": "Customer_ProductPriceList_Load_Query",
    "PriceGroup_Name": "Customer Specific Pricing",
    "Customer_Login": "parovarium",
    "Discounted": true,
    "Undiscounted": false,
    "Count": 0,
    "Offset": 0,
    "Sort": "login",
    "Filter": []
}

Example Response#

{
    "success": 1,
    "data": {
        "total_count": 1,
        "start_offset": 0,
        "data": [
            {
                "id": 3,
                "code": "armor-leather",
                "sku": "",
                "name": "Leather Armor",
                "thumbnail": "",
                "image": "",
                "price": 100.0,
                "formatted_price": "$100.00",
                "cost": 75.0,
                "formatted_cost": "$75.00",
                "weight": 15.0,
                "taxable": true,
                "active": true,
                "page_title": "",
                "dt_created": 1595517720,
                "dt_Updated": 1595517720,
                "discounted_price": 17.56
            }
        ]
    }
}