Skip to content



This function loads a list of products by Availability Group.

Request Parameters#

Type Description
assigned Boolean true/false whether customer is assigned to this availability group
Availability Group ID
Availability Group Name
Availability Group Name
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
unassigned Boolean Boolean value indicating if the query returns unassigned products

Response Parameters#

Type Description
success Number 1 indicating a successful request.
0 indicating an unsuccessful request.
total_count Number The number of products returned
start_offset Number The offset starting point for pagination of return data
assigned Boolean Boolean value indicating if the product is currently assigned to the availability group
id Number The product id
code String The product code
sku String The product sku
name String The product name
thumbnail String The filepath for the product thumbnail
image String The filepath for the product image
price Number The price of the product
formatted_price String Currency formatted price of the product
cost Number The product cost
formatted_cost String Currency formatted product cost
weight Number The product weight
taxable Boolean Boolean value indicating if the product is tax exempt
active Boolean Boolean value indicating if the product is active
page_title String The title of the 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": "AvailabilityGroupProductList_Load_Query",
    "Assigned": true,
    "AvailabilityGroup_ID": 4,
    "Count": 18,
    "Filter": "",
    "Offset": 0,
    "Sort": "disp_order",
    "Unassigned": true

Example Response#

  "success": 1,
  "data": {
    "total_count": 211,
    "start_offset": 0,
    "data": [
        "assigned": false,
        "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": false,
        "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