24/7 Support: 800.608.6482

Navigation

AvailabilityGroupProductList_Load_Query

This function loads a list of products by Availability Group.

Request Parameters

store_code Type:
String		 Title:
Store Code		 Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String		 Title:
Availability Group Product List Load Query		 The name of the function being executed
assigned Type:
Boolean		 Title:
Assigned		 Boolean value indicating if the query returns assigned products
availabilitygroup_id Type:
Number		 Title:
Availability Group ID		 The id number of the availability group
count Type:
Number		 Title:
Count		 Maximum lines of data allowed to be returned in the response. This limit is used to prevent excessive amounts of data return
filter Type:
String		 Title:
Filter		 A string for filtering returned data
offset Type:
Number		 Title:
Offset		 Used with the Count parameter for paginating results of large datasets. Default 0 is no offset.
sort Type:
String		 Title:
Sort		 The order for sorting returned data
unassigned Type:
Boolean		 Title:
Unassigned		 Boolean value indicating if the query returns unassigned products

Response Parameters

success Type:
Boolean		 Title:
Status Response		 Boolean value indicating if the api request was successful
total_count Type:
Number		 Title:
Total Count		 the number of products returned
start_offset Type:
Number		 Title:
Start Offset		 the offset starting point for pagination of return data
assigned Type:
Boolean		 Title:
Assigned		 Boolean value indicating if the product is currently assigned to the availability group
id Type:
Number		 Title:
Product ID		 The product id
code Type:
String		 Title:
Product Code		 The product code
sku Type:
String		 Title:
Product SKU		 The product sku
name Type:
String		 Title:
Product Name		 The product name
thumbnail Type:
String		 Title:
Product Thumbnail		 The filepath for the product thumbnail
image Type:
String		 Title:
Product Image		 The filepath for the product image
price Type:
Number		 Title:
Product Price		 The price of the product
formatted_price Type:
String		 Title:
Currency Formatted Product Price		 Currency formatted price of the product
cost Type:
Number		 Title:
Product Cost		 The product cost
formatted_cost Type:
String		 Title:
Currency Formatted Product Cost		 Currency formatted product cost
weight Type:
Number		 Title:
Product Weight		 The product weight
taxable Type:
Boolean		 Title:
Tax Exempt Product Status		 Boolean value indicating if the product is tax exempt
active Type:
Boolean		 Title:
Active Product		 Boolean value indicating if the product is active
page_title Type:
String		 Title:
Product Page Title		 The title of the product page
dt_created Type:
Number		 Title:
Product Creation Date		 Unix timestamp for the product creation date
dt_updated Type:
Number		 Title:
Product Update Date		 Unix timestamp for the product's most recent update

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.