{"_id":"5632a5ea49e16d0d00122497","project":"55b933b3146ef121002158d3","__v":0,"category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"user":"55b932ba8fd1a02b00f496c8","githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:57:12.015Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":21,"body":"Contains results of a products search.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object is returned by the [searchProducts](/docs/searchproducts), [searchProductsCustom](/docs/searchproductscustom), [searchProductsCount](/docs/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\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"integer\",\n    \"0-1\": \"ProductsMatched\",\n    \"0-2\": \"Total number of transactions matched\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"ProductsReturned\",\n    \"1-2\": \"Number of transactions returned in this result set\",\n    \"2-0\": \"integer\",\n    \"2-1\": \"StartIndex\",\n    \"2-2\": \"The starting index used (defaults to 0)\",\n    \"3-0\": \"integer\",\n    \"3-1\": \"Limit\",\n    \"3-2\": \"The max number transactions to return in each result set.\",\n    \"4-0\": \"[Product](/docs/product)\",\n    \"4-1\": \"Products\",\n    \"4-2\": \"An array Products for the matched criteria\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]","excerpt":"","slug":"productsearchresult","type":"basic","title":"ProductSearchResult"}

ProductSearchResult


Contains results of a products search. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object is returned by the [searchProducts](/docs/searchproducts), [searchProductsCustom](/docs/searchproductscustom), [searchProductsCount](/docs/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 [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "integer", "0-1": "ProductsMatched", "0-2": "Total number of transactions matched", "1-0": "integer", "1-1": "ProductsReturned", "1-2": "Number of transactions returned in this result set", "2-0": "integer", "2-1": "StartIndex", "2-2": "The starting index used (defaults to 0)", "3-0": "integer", "3-1": "Limit", "3-2": "The max number transactions to return in each result set.", "4-0": "[Product](/docs/product)", "4-1": "Products", "4-2": "An array Products for the matched criteria" }, "cols": 3, "rows": 5 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block]