{"_id":"5632a5ed49e16d0d001224d2","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"},"githubsync":"","project":"55b933b3146ef121002158d3","__v":0,"category":{"_id":"5632a5e749e16d0d00122449","project":"55b933b3146ef121002158d3","__v":1,"version":"5632a5e549e16d0d00122443","pages":["5632a5ed49e16d0d001224cc","5632a5ed49e16d0d001224cd","5632a5ed49e16d0d001224ce","5632a5ed49e16d0d001224cf","5632a5ed49e16d0d001224d0","5632a5ed49e16d0d001224d1","5632a5ed49e16d0d001224d2","5632a5ed49e16d0d001224d3","5632a5ed49e16d0d001224d4","5632a5ed49e16d0d001224d5","5632a5ed49e16d0d001224d6","5632a5ed49e16d0d001224d7","5632a5ed49e16d0d001224d8","5632a5ed49e16d0d001224d9","5632a5ed49e16d0d001224da","5632a5ed49e16d0d001224db","5632a5ed49e16d0d001224dc","5632a5ed49e16d0d001224dd","5632a5ed49e16d0d001224de","5632a5ed49e16d0d001224df","5632a5ed49e16d0d001224e0"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-03T18:12:10.391Z","from_sync":false,"order":7,"slug":"customers-tokenization","title":"Customers (Tokenization)"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-03T18:14:53.634Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"Search for customers.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to search the customer database using flexible search terms. This method searches the customer database (aka recurring billing) not the transactions history. To search the transaction history for a specific customer, use either the [searchTransactions](/docs/searchtransactions) or [getCustomerHistory](/docs/getcustomerhistory) method.\nUse as many or as few search terms as you like. With MatchAll set to “true,” all terms must match to return a result. If the search does not yield the desired results, try broadening your search by eliminating terms, or change MatchAll to “false.”\nValid field names for search and sort are:\n  * BillingAddress.FirstName\n  * BillingAddress.lastname\n  * BillingAddress.Company\n  * BillingAddress.Street\n  * BillingAddress.Street2\n  * BillingAddress.City\n  * BillingAddress.State\n  * BillingAddress.Zip\n  * BillingAddress.Country\n  * BillingAddress.Phone\n  * BillingAddress.Fax\n  * BillingAddress.Email\n  * Amount\n  * CustNum\n  * CustomerID\n  * Created\n  * Description\n  * Enabled\n  * Failures\n  * Modified\n  * Start\n  * Next\n  * Notes\n  * NumLeft\n  * OrderID\n  * ReceiptNote\n  * Schedule (1=Daily,2=Weekly,3=Bi-Weekly,4=Monthly,5=Bi-Monthly,6=Quarterly,7=Bi-Annually,8=Annually,9=First of Month, 10=Last Day of Month)\n  * SendReceipt\n  * Source\n  * Tax\n  * User \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[CustomerSearchResul](/docs/customersearchresult)t **searchCustomers** ( [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.\",\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\": \"Start position, defaults to 0 (first customer found).\",\n    \"4-0\": \"integer\",\n    \"4-1\": \"Limit\",\n    \"4-2\": \"Maximum number of customers to return in result.\",\n    \"5-0\": \"string\",\n    \"5-1\": \"Sort\",\n    \"5-2\": \"Field name to sort the results 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-0\": \"[CustomerSearchResult](/docs/customersearchresult)\",\n    \"0-1\": \"Returns results of customer search based on parameters set.\"\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 \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\ntry {\\n $search=array(\\n   array(\\n     'Field'=>'amount',  \\n     'Type'=>'gt',\\n     'Value'=>'8.00'),\\n   array(\\n     'Field'=>'failures',  \\n     'Type'=>'gt',  \\n     'Value'=>'0')\\n   );\\n $start=0;\\n $limit=10;\\n $matchall=true;\\n $RefNum=1009411;\\n $Sort = \\\"fname\\\";\\n $res=$client->searchCustomers($token,$search,$matchall,$start,$limit,$Sort);\\n print_r($res);\\n $this->assertTrue($res->CustomersMatched>0 && $res->CustomersReturned>0);\\n}\\ncatch (SoapFault $e) {\\n die(\\\"Search Customers failed :\\\" .$e->getMessage());\\n}\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim matchAll As Boolean\\n       matchAll = True\\n       Dim search(0) As eBizCharge.SearchParam\\n       search(0) = New eBizCharge.SearchParam()\\n       search(0).Field = \\\"Created\\\"\\n       search(0).Type = \\\"Contains\\\"\\n       search(0).Value = \\\"2010-09-09\\\"\\n       Dim response As eBizCharge.CustomerSearchResult = New eBizCharge.CustomerSearchResult\\n       response = client.searchCustomers(token, search, matchAll, \\\"0\\\", \\\"10\\\", \\\"fname\\\")\\n       MsgBox(response.CustomersMatched)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Boolean matchAll;\\n           matchAll = true;\\n           eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];\\n           search[0] = new eBizCharge.SearchParam();\\n           search[0].Field = \\\"Created\\\";\\n           search[0].Type = \\\"Contains\\\";\\n           search[0].Value = \\\"2010-08-10\\\";\\n           eBizCharge.CustomerSearchResult response = new eBizCharge.CustomerSearchResult();\\n           try\\n           {\\n               response = client.searchCustomers(token, search, matchAll, \\\"0\\\", \\\"10\\\", \\\"fname\\\");\\n               MessageBox.Show(response.CustomersMatched);\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"searchcustomers","type":"basic","title":"searchCustomers"}
Search for customers. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to search the customer database using flexible search terms. This method searches the customer database (aka recurring billing) not the transactions history. To search the transaction history for a specific customer, use either the [searchTransactions](/docs/searchtransactions) or [getCustomerHistory](/docs/getcustomerhistory) method. Use as many or as few search terms as you like. With MatchAll set to “true,” all terms must match to return a result. If the search does not yield the desired results, try broadening your search by eliminating terms, or change MatchAll to “false.” Valid field names for search and sort are: * BillingAddress.FirstName * BillingAddress.lastname * BillingAddress.Company * BillingAddress.Street * BillingAddress.Street2 * BillingAddress.City * BillingAddress.State * BillingAddress.Zip * BillingAddress.Country * BillingAddress.Phone * BillingAddress.Fax * BillingAddress.Email * Amount * CustNum * CustomerID * Created * Description * Enabled * Failures * Modified * Start * Next * Notes * NumLeft * OrderID * ReceiptNote * Schedule (1=Daily,2=Weekly,3=Bi-Weekly,4=Monthly,5=Bi-Monthly,6=Quarterly,7=Bi-Annually,8=Annually,9=First of Month, 10=Last Day of Month) * SendReceipt * Source * Tax * User [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [CustomerSearchResul](/docs/customersearchresult)t **searchCustomers** ( [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.", "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": "Start position, defaults to 0 (first customer found).", "4-0": "integer", "4-1": "Limit", "4-2": "Maximum number of customers to return in result.", "5-0": "string", "5-1": "Sort", "5-2": "Field name to sort the results by" }, "cols": 3, "rows": 6 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "[CustomerSearchResult](/docs/customersearchresult)", "0-1": "Returns results of customer search based on parameters set." }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $search=array(\n array(\n 'Field'=>'amount', \n 'Type'=>'gt',\n 'Value'=>'8.00'),\n array(\n 'Field'=>'failures', \n 'Type'=>'gt', \n 'Value'=>'0')\n );\n $start=0;\n $limit=10;\n $matchall=true;\n $RefNum=1009411;\n $Sort = \"fname\";\n $res=$client->searchCustomers($token,$search,$matchall,$start,$limit,$Sort);\n print_r($res);\n $this->assertTrue($res->CustomersMatched>0 && $res->CustomersReturned>0);\n}\ncatch (SoapFault $e) {\n die(\"Search Customers failed :\" .$e->getMessage());\n}\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim matchAll As Boolean\n matchAll = True\n Dim search(0) As eBizCharge.SearchParam\n search(0) = New eBizCharge.SearchParam()\n search(0).Field = \"Created\"\n search(0).Type = \"Contains\"\n search(0).Value = \"2010-09-09\"\n Dim response As eBizCharge.CustomerSearchResult = New eBizCharge.CustomerSearchResult\n response = client.searchCustomers(token, search, matchAll, \"0\", \"10\", \"fname\")\n MsgBox(response.CustomersMatched)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "Boolean matchAll;\n matchAll = true;\n eBizCharge.SearchParam[] search = new eBizCharge.SearchParam[2];\n search[0] = new eBizCharge.SearchParam();\n search[0].Field = \"Created\";\n search[0].Type = \"Contains\";\n search[0].Value = \"2010-08-10\";\n eBizCharge.CustomerSearchResult response = new eBizCharge.CustomerSearchResult();\n try\n {\n response = client.searchCustomers(token, search, matchAll, \"0\", \"10\", \"fname\");\n MessageBox.Show(response.CustomersMatched);\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block]