Skip to content

`PriceGroupQualifyingProductList_Load_Query`#

Description#

This function loads a list of qualifying products by price group.

Request 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
`pricegroup_id` `pricegroup_code` `edit_pricegroup`	Number String String	ID of the Price Group. Price Group code Price Group code
`assigned`	Boolean	Boolean value indicating if the query returns assigned qualifying products
`unassigned`	Boolean	Boolean value indicating if the query returns unassigned products

Response Parameters#

Parameter	Type	Description
`success`	Boolean	Boolean value indicating if the API request was successful
`total_count`	Number	The number of qualifying products returned
`start_offset`	Number	The offset starting point for pagination of return data
`assigned`	Boolean	Boolean value indicating if the qualifying product is currently assigned to the availability group
`id`	Number	The qualifying product id
`code`	String	The qualifying product code
`sku`	String	The qualifying product sku
`name`	String	The qualifying product name
`thumbnail`	String	The filepath for the qualifying product thumbnail
`image`	String	The filepath for the qualifying product image
`price`	Number	The price of the qualifying product
`formatted_price`	String	Currency formatted price of the qualifying product
`cost`	Number	The qualifying product cost
`formatted_cost`	String	Currency formatted qualifying product cost
`weight`	Number	The qualifying product weight
`taxable`	Boolean	Boolean value indicating if the qualifying product is tax exempt
`active`	Boolean	Boolean value indicating if the qualifying product is active
`page_title`	String	The title of the qualifying product page
`dt_created`	Number	Unix timestamp for the product creation date
`dt_Updated`	Number	Unix timestamp for the product’s most recent update

Example Request#

{
    "Store_code": "beta",
    "Function": "PriceGroupQualifyingProductList_Load_Query",
    "Assigned": true,
    "Count": 18,
    "Filter": "",
    "Offset": 0,
    "PriceGroup_ID": 2,
    "Sort": "disp_order",
    "Unassigned": true
}

Example Response#

{
  "success": 1,
  "data": {
    "total_count": 211,
    "start_offset": 0,
    "data": [
      {
        "assigned": true,
        "id": 1,
        "code": "shirt",
        "sku": "",
        "name": "Shirt",
        "thumbnail": "",
        "image": "",
        "price": 20.0,
        "formatted_price": "$20.00",
        "cost": 5.0,
        "formatted_cost": "$5.00",
        "weight": 1.0,
        "taxable": true,
        "active": true,
        "page_title": "",
        "dt_created": 1623689542,
        "dt_Updated": 1633158447
      },
      {
        "assigned": true,
        "id": 2,
        "code": "59535-4601",
        "sku": "53208-377",
        "name": "Pastry - Key Limepoppy Seed Tea",
        "thumbnail": "",
        "image": "",
        "price": 20.45,
        "formatted_price": "$20.45",
        "cost": 74.11,
        "formatted_cost": "$74.11",
        "weight": 10.0,
        "taxable": true,
        "active": true,
        "page_title": "",
        "dt_created": 1623690274,
        "dt_Updated": 1623690274
      },
      ...
    ]
  }
}