{"_id":"5632a5e749e16d0d0012245d","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"},"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"},"project":"55b933b3146ef121002158d3","__v":0,"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:42:03.149Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"Search products and return full product records.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThe following fields may be used to search the database and return transaction details:\n  * ProductID\n  * ProductRefNum\n  * SKU\n  * CategoryID\n  * Enabled\n  * Name\n  * Description\n  * Model\n  * Weight\n  * ShipWeight\n  * Price\n  * WholesalePrice\n  * ListPrice\n  * DateAvailable\n  * Manufacturer\n  * Type\n  * MinQuantity\n  * MaxQuantity\n  * ImageURL\n  * URL \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[ProductSearchResult](/docs/productsearchresult) **searchProducts** ( [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    \"1-0\": \"[SearchParam](/docs/searchparam)\",\n    \"0-1\": \"Token\",\n    \"0-2\": \"Merchant security token: used to identify merchant and validate transaction.\",\n    \"1-1\": \"Search\",\n    \"1-2\": \"Array of search parameters (ProductSearchParam 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\": \"Record number to start returning from (ie if 1,000 were found and you only want to receive the last 200 you would set Start=800 and Limit=200)\",\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 product 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[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\ntry {\\n // Create search parameter list\\n $search=array(\\n   array(\\n     'Field'=>'name',  \\n     'Type'=>'eq',\\n     'Value'=>'A Great Product')\\n   );\\n $start=0;\\n $limit=100;\\n $matchall=true;\\n $sort='created';\\n $res=$client->searchProducts($token,$search,$matchall,$start,$limit,$sort);\\n print_r($res);\\n}\\ncatch(SoapFault $e) {\\n echo $client->__getLastResponse();\\n die(\\\"Search Products Failed :\\\".$e->getMessage());\\n}\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## PHP 4 (NuSOAP) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\ninclude './nusoap.php';\\n// Create Soap Client\\n$s=new soapclient(\\\"./eBizCharge.wsdl\\\",'wsdl');\\n$tran=$s->getProxy();\\n// Source Key Setting\\n$sourcekey='yQbOFkjD8wwlkZ3AhY248k3Lc9PH1l14';\\n$pin='1234';\\n// Prep source key\\n$seed=mktime() . rand();\\n$tmp=$sourcekey . $seed . $pin;\\n$hash=sha1($tmp);\\n$token=array('SourceKey'=>$sourcekey, 'PinHash'=>array('Type'=>'sha1', 'Seed'=>$seed,'HashValue'=>$hash));\\n// Prep Request data\\n$search=array(\\n     array('Field'=>'title', 'Type'=>'eq','Value'=>'A Great Product')\\n);\\n$start=0;\\n$limit=10;\\n$matchall=true;\\n$sort='created';\\n$res=$tran->searchProducts($token,$search,$matchall,$start,$limit,$sort);\\nif(!$err=$tran->getError()) {\\n       print_r($res);\\n} else {\\n       echo \\\"Error: $err\\\\n\\\";\\n       echo $tran->request;  \\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 = 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.searchProducts(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.searchProducts(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]\n## Coldfusion \n*NOTE*: this example has not been tested and is provided as is\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<cfscript>\\nStart = 0;\\nLimit = 10;\\nMatchAll=1;\\nSort='created';\\nSearch=ArrayNew(1);\\nSearch[1]=structnew();\\nSearch[1].Field='created';\\nSearch[1].Type='gt';\\nSearch[1].Value='2006-09-01';\\nws = createObject(\\\"webservice\\\", \\\"https://secure.eBizCharge.com/soap/gate/3213EA2A/eBizCharge.wsdl\\\");\\nOutput = ws.searchTransactions(Token, Search, MatchAll, Start, Limit, Sort);\\n</cfscript>\",\n      \"language\": \"coffeescript\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\nxmlns:ns1=\\\"urn:eBizCharge\\\" xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\nxmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\nxmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\nSOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:searchTransactions>\\n<Token xsi:type=\\\"ns1:ueSecurityToken\\\">\\n<ClientIP xsi:type=\\\"xsd:string\\\">192.168.0.1</ClientIP>\\n<PinHash xsi:type=\\\"ns1:ueHash\\\">\\n<HashValue xsi:type=\\\"xsd:string\\\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\\n<Seed xsi:type=\\\"xsd:string\\\">12678150211876663375</Seed>\\n<Type xsi:type=\\\"xsd:string\\\">sha1</Type>\\n</PinHash>\\n<SourceKey xsi:type=\\\"xsd:string\\\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\\n</Token>\\n<Search SOAP-ENC:arrayType=\\\"ns1:SearchParam[1]\\\" xsi:type=\\\"ns1:SearchParamArray\\\">\\n<item xsi:type=\\\"ns1:SearchParam\\\">\\n<Field xsi:type=\\\"xsd:string\\\">amount</Field>\\n<Type xsi:type=\\\"xsd:string\\\">eq</Type>\\n<Value xsi:type=\\\"xsd:string\\\">29.00</Value>\\n</item>\\n</Search>\\n<MatchAll xsi:type=\\\"xsd:boolean\\\">true</MatchAll>\\n<Start xsi:type=\\\"xsd:integer\\\">0</Start>\\n<Limit xsi:type=\\\"xsd:integer\\\">10</Limit>\\n<Sort xsi:type=\\\"xsd:string\\\">created</Sort>\\n</ns1:searchTransactions>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"searchproducts","type":"basic","title":"searchProducts"}
Search products and return full product records. [block:api-header] { "type": "basic", "title": "Description" } [/block] The following fields may be used to search the database and return transaction details: * ProductID * ProductRefNum * SKU * CategoryID * Enabled * Name * Description * Model * Weight * ShipWeight * Price * WholesalePrice * ListPrice * DateAvailable * Manufacturer * Type * MinQuantity * MaxQuantity * ImageURL * URL [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [ProductSearchResult](/docs/productsearchresult) **searchProducts** ( [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)", "1-0": "[SearchParam](/docs/searchparam)", "0-1": "Token", "0-2": "Merchant security token: used to identify merchant and validate transaction.", "1-1": "Search", "1-2": "Array of search parameters (ProductSearchParam 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": "Record number to start returning from (ie if 1,000 were found and you only want to receive the last 200 you would set Start=800 and Limit=200)", "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 product 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 [block:code] { "codes": [ { "code": "<?php\ntry {\n // Create search parameter list\n $search=array(\n array(\n 'Field'=>'name', \n 'Type'=>'eq',\n 'Value'=>'A Great Product')\n );\n $start=0;\n $limit=100;\n $matchall=true;\n $sort='created';\n $res=$client->searchProducts($token,$search,$matchall,$start,$limit,$sort);\n print_r($res);\n}\ncatch(SoapFault $e) {\n echo $client->__getLastResponse();\n die(\"Search Products Failed :\".$e->getMessage());\n}\n?>", "language": "php" } ] } [/block] ## PHP 4 (NuSOAP) [block:code] { "codes": [ { "code": "<?php\ninclude './nusoap.php';\n// Create Soap Client\n$s=new soapclient(\"./eBizCharge.wsdl\",'wsdl');\n$tran=$s->getProxy();\n// Source Key Setting\n$sourcekey='yQbOFkjD8wwlkZ3AhY248k3Lc9PH1l14';\n$pin='1234';\n// Prep source key\n$seed=mktime() . rand();\n$tmp=$sourcekey . $seed . $pin;\n$hash=sha1($tmp);\n$token=array('SourceKey'=>$sourcekey, 'PinHash'=>array('Type'=>'sha1', 'Seed'=>$seed,'HashValue'=>$hash));\n// Prep Request data\n$search=array(\n array('Field'=>'title', 'Type'=>'eq','Value'=>'A Great Product')\n);\n$start=0;\n$limit=10;\n$matchall=true;\n$sort='created';\n$res=$tran->searchProducts($token,$search,$matchall,$start,$limit,$sort);\nif(!$err=$tran->getError()) {\n print_r($res);\n} else {\n echo \"Error: $err\\n\";\n echo $tran->request; \n}", "language": "php" } ] } [/block] ## 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.searchProducts(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.searchProducts(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] ## Coldfusion *NOTE*: this example has not been tested and is provided as is [block:code] { "codes": [ { "code": "<cfscript>\nStart = 0;\nLimit = 10;\nMatchAll=1;\nSort='created';\nSearch=ArrayNew(1);\nSearch[1]=structnew();\nSearch[1].Field='created';\nSearch[1].Type='gt';\nSearch[1].Value='2006-09-01';\nws = createObject(\"webservice\", \"https://secure.eBizCharge.com/soap/gate/3213EA2A/eBizCharge.wsdl\");\nOutput = ws.searchTransactions(Token, Search, MatchAll, Start, Limit, Sort);\n</cfscript>", "language": "coffeescript" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\nxmlns:ns1=\"urn:eBizCharge\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\nxmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\nxmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\nSOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:searchTransactions>\n<Token xsi:type=\"ns1:ueSecurityToken\">\n<ClientIP xsi:type=\"xsd:string\">192.168.0.1</ClientIP>\n<PinHash xsi:type=\"ns1:ueHash\">\n<HashValue xsi:type=\"xsd:string\">11ac55b0a0b59f8f028dbf85bc32266fa973dd0e</HashValue>\n<Seed xsi:type=\"xsd:string\">12678150211876663375</Seed>\n<Type xsi:type=\"xsd:string\">sha1</Type>\n</PinHash>\n<SourceKey xsi:type=\"xsd:string\">HB4P7C4K2w2ZCQQQXRqrxDj6agrS2NIT</SourceKey>\n</Token>\n<Search SOAP-ENC:arrayType=\"ns1:SearchParam[1]\" xsi:type=\"ns1:SearchParamArray\">\n<item xsi:type=\"ns1:SearchParam\">\n<Field xsi:type=\"xsd:string\">amount</Field>\n<Type xsi:type=\"xsd:string\">eq</Type>\n<Value xsi:type=\"xsd:string\">29.00</Value>\n</item>\n</Search>\n<MatchAll xsi:type=\"xsd:boolean\">true</MatchAll>\n<Start xsi:type=\"xsd:integer\">0</Start>\n<Limit xsi:type=\"xsd:integer\">10</Limit>\n<Sort xsi:type=\"xsd:string\">created</Sort>\n</ns1:searchTransactions>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]