{"_id":"5632a5e749e16d0d0012245e","githubsync":"","project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","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"},"__v":0,"category":{"_id":"5632a5e749e16d0d0012244a","version":"5632a5e549e16d0d00122443","__v":1,"pages":["5632a5e749e16d0d00122451","5632a5e749e16d0d00122452","5632a5e749e16d0d00122453","5632a5e749e16d0d00122454","5632a5e749e16d0d00122455","5632a5e749e16d0d00122456","5632a5e749e16d0d00122457","5632a5e749e16d0d00122458","5632a5e749e16d0d00122459","5632a5e749e16d0d0012245a","5632a5e749e16d0d0012245b","5632a5e749e16d0d0012245c","5632a5e749e16d0d0012245d","5632a5e749e16d0d0012245e","5632a5e749e16d0d0012245f"],"project":"55b933b3146ef121002158d3","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:33:11.503Z","from_sync":false,"order":9,"slug":"products","title":"Products"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:42:13.887Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":13,"body":"Search the product database, only return number of products matched\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nIdentical to the [searchProducts](/docs/searchproducts) method except only the product counts are returned. Like [searchProducts](/docs/searchproducts), this method returns [ProductSearchResult](/docs/productsearchresult). The only difference is that ProductSearchResult.Products is left empty. This method provides a quicker way to determine the size of the result set before starting to retrieve the full search results.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[ProductSearchResult](/docs/productsearchresult) **searchProductsCount** ( [ueSecurityToken](/docs/uesecuritytoken) Token, [SearchParam](/docs/searchparam) Search, boolean MatchAll, integer Start, integer Limit, string Sort)\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Arguments\"\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\": \"[ueSecurityToken](/docs/uesecuritytoken)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and validate transaction.\",\n    \"1-0\": \"[SearchParam](/docs/searchparam)\",\n    \"1-1\": \"Search\",\n    \"1-2\": \"Array of search parameters (SearchParam objects) available.\",\n    \"2-0\": \"boolean\",\n    \"2-1\": \"MatchAll\",\n    \"2-2\": \"If set to “true,” only results matching all search criteria will be returned, if set to “false,” results matching any of the search criteria will be returned.\",\n    \"3-0\": \"integer\",\n    \"3-1\": \"Start\",\n    \"3-2\": \"Sequence number to start returning on.\",\n    \"4-0\": \"integer\",\n    \"4-1\": \"Limit\",\n    \"4-2\": \"Maximum number of transactions to return in result set.\",\n    \"5-0\": \"string\",\n    \"5-1\": \"Sort\",\n    \"5-2\": \"Comma separated list of fields to sort by.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Return Value\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-1\": \"Returns full products records for all products matching the specified search parameters.\",\n    \"0-0\": \"[ProductSearchResult](/docs/productsearchresult)\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## PHP 5 \n\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim MatchAll As Boolean\\n       MatchAll = False\\n       Dim searchParams(1) As eBizCharge.SearchParam\\n       searchParams(0) = New eBizCharge.SearchParam\\n       searchParams(0).Field = \\\"Created\\\"\\n       searchParams(0).Type = \\\"gt\\\"\\n       searchParams(0).Value = \\\"2010-09-07\\\"\\n       Dim SearchResults As eBizCharge.ProductSearchResult = New eBizCharge.ProductSearchResult\\n       SearchResults = client.searchProductsCount(token, searchParams, MatchAll, 0, 1000, \\\"created\\\")\\n       MsgBox(SearchResults.ProductsMatched)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.SearchParam[] param = new eBizCharge.SearchParam[1];\\n           param[0] = new eBizCharge.SearchParam();\\n           param[0].Field = \\\"Created\\\";\\n           param[0].Type = \\\"Contains\\\";\\n           param[0].Value = \\\"2010-08-12\\\";\\n           Boolean matchAll = true;\\n           string start = \\\"0\\\";\\n           string limit = \\\"10\\\";\\n           string sort = \\\"created\\\";\\n           eBizCharge.ProductSearchResult response = new eBizCharge.ProductSearchResult();\\n           try\\n           {\\n               response = client.searchProductsCount(token, param, matchAll, start, limit, sort);\\n               MessageBox.Show(string.Concat(response.ProductsMatched));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"searchproductscount","type":"basic","title":"searchProductsCount"}

searchProductsCount


Search the product database, only return number of products matched [block:api-header] { "type": "basic", "title": "Description" } [/block] Identical to the [searchProducts](/docs/searchproducts) method except only the product counts are returned. Like [searchProducts](/docs/searchproducts), this method returns [ProductSearchResult](/docs/productsearchresult). The only difference is that ProductSearchResult.Products is left empty. This method provides a quicker way to determine the size of the result set before starting to retrieve the full search results. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [ProductSearchResult](/docs/productsearchresult) **searchProductsCount** ( [ueSecurityToken](/docs/uesecuritytoken) Token, [SearchParam](/docs/searchparam) Search, boolean MatchAll, integer Start, integer Limit, string Sort) [block:api-header] { "type": "basic", "title": "Arguments" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "[ueSecurityToken](/docs/uesecuritytoken)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and validate transaction.", "1-0": "[SearchParam](/docs/searchparam)", "1-1": "Search", "1-2": "Array of search parameters (SearchParam objects) available.", "2-0": "boolean", "2-1": "MatchAll", "2-2": "If set to “true,” only results matching all search criteria will be returned, if set to “false,” results matching any of the search criteria will be returned.", "3-0": "integer", "3-1": "Start", "3-2": "Sequence number to start returning on.", "4-0": "integer", "4-1": "Limit", "4-2": "Maximum number of transactions to return in result set.", "5-0": "string", "5-1": "Sort", "5-2": "Comma separated list of fields to sort by." }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-1": "Returns full products records for all products matching the specified search parameters.", "0-0": "[ProductSearchResult](/docs/productsearchresult)" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP 5 ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim MatchAll As Boolean\n MatchAll = False\n Dim searchParams(1) As eBizCharge.SearchParam\n searchParams(0) = New eBizCharge.SearchParam\n searchParams(0).Field = \"Created\"\n searchParams(0).Type = \"gt\"\n searchParams(0).Value = \"2010-09-07\"\n Dim SearchResults As eBizCharge.ProductSearchResult = New eBizCharge.ProductSearchResult\n SearchResults = client.searchProductsCount(token, searchParams, MatchAll, 0, 1000, \"created\")\n MsgBox(SearchResults.ProductsMatched)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.SearchParam[] param = new eBizCharge.SearchParam[1];\n param[0] = new eBizCharge.SearchParam();\n param[0].Field = \"Created\";\n param[0].Type = \"Contains\";\n param[0].Value = \"2010-08-12\";\n Boolean matchAll = true;\n string start = \"0\";\n string limit = \"10\";\n string sort = \"created\";\n eBizCharge.ProductSearchResult response = new eBizCharge.ProductSearchResult();\n try\n {\n response = client.searchProductsCount(token, param, matchAll, start, limit, sort);\n MessageBox.Show(string.Concat(response.ProductsMatched));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block]