Differences

This shows you the differences between two versions of the page.

@@ Line 1: / Line 1: @@
+<embed ..:contents/>====== ProductSearchResult ======
+Contains results of a products search.
+===== Description =====
+This object is returned by the [[..:methods:searchProducts]], [[..:methods:searchProductsCustom]], [[..:methods:searchProductsCount]] methods. It describes the result of the search, including the total number of products matched, the number being returned, and an array of Product Objects
+===== Properties =====
+^Type    ^Name    ^Description     ^
+|integer |ProductsMatched |Total number of transactions matched|
+|integer |ProductsReturned |Number of transactions returned in this result set|
+|integer |StartIndex |The starting index used (defaults to 0)|
+|integer |Limit |The max number transactions to return in each result set.|
+|[[.:Product]] |Products |An array Products for the matched criteria|
+===== Places Used =====
+[[..:methods:searchProducts]]
+[[..:methods:searchProductsCustom]]
+[[..:methods:searchProductsCount]]
+===== Examples =====