{"_id":"5632a5e749e16d0d00122458","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"},"githubsync":"","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"},"project":"55b933b3146ef121002158d3","__v":0,"user":"55b932ba8fd1a02b00f496c8","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:41:01.977Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"Retrieve all product categories\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method retrieves an array of [ProductCategory](/docs/productcategory) objects for all product categories.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[ProductCategory](/docs/productcategory)[] **getProductCategories** ( [ueSecurityToken](/docs/uesecuritytoken) Token)\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 retrieve the custom fields.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\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\": \"[ProductCategory](/docs/productcategory)\",\n    \"0-1\": \"Returns an array of [ProductCategory](/docs/productcategory) objects containing information on the product categories\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Exceptions\"\n}\n[/block]\nThe following exceptions (errors) are applicable to this method.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"\",\n    \"0-1\": \"Message\",\n    \"0-2\": \"Advice\",\n    \"0-0\": \"Code\"\n  },\n  \"cols\": 3,\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\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim category() As eBizCharge.ProductCategory\\n       category = client.getProductCategories(token)\\n       MsgBox(category.Length)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \" try\\n           {\\n               eBizCharge.ProductCategory[] category = client.getProductCategories(token);\\n               MessageBox.Show(string.Concat(category.Length));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Request:\\n<?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:getProductCategories>\\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</ns1:getProductCategories>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n<?xml version=\\\"1.0\\\" encoding=\\\"utf-8\\\"?>\\n<SOAP-ENV:Envelope\\nxmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\nxmlns:ns1=\\\"urn:eBizCharge\\\"\\nxmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\nxmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\nxmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\" SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n <SOAP-ENV:Body>\\n   <ns1:getProductCategoriesResponse>\\n     <getProductCategoriesReturn SOAP-ENC:arrayType=\\\"ns1:ProductCategory[4]\\\" xsi:type=\\\"ns1:ProductCategoryArray\\\">\\n       <item xsi:type=\\\"ns1:ProductCategory\\\">\\n         <ProductCategoryRefNum xsi:type=\\\"xsd:string\\\">900100191</ProductCategoryRefNum>\\n         <Name xsi:type=\\\"xsd:string\\\">Books:Math</Name>\\n       </item>\\n       <item xsi:type=\\\"ns1:ProductCategory\\\">\\n         <ProductCategoryRefNum xsi:type=\\\"xsd:string\\\">900100193</ProductCategoryRefNum>\\n         <Name xsi:type=\\\"xsd:string\\\">Example Category</Name>\\n       </item>\\n       <item xsi:type=\\\"ns1:ProductCategory\\\">\\n         <ProductCategoryRefNum xsi:type=\\\"xsd:string\\\">900100194</ProductCategoryRefNum>\\n         <Name xsi:type=\\\"xsd:string\\\">Example Category</Name>\\n       </item>\\n       <item xsi:type=\\\"ns1:ProductCategory\\\">\\n         <ProductCategoryRefNum xsi:type=\\\"xsd:string\\\">900100192</ProductCategoryRefNum>\\n         <Name xsi:type=\\\"xsd:string\\\">Test Category</Name>\\n       </item>\\n     </getProductCategoriesReturn>\\n   </ns1:getProductCategoriesResponse>\\n </SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"getproductcategories","type":"basic","title":"getProductCategories"}

getProductCategories


Retrieve all product categories [block:api-header] { "type": "basic", "title": "Description" } [/block] This method retrieves an array of [ProductCategory](/docs/productcategory) objects for all product categories. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [ProductCategory](/docs/productcategory)[] **getProductCategories** ( [ueSecurityToken](/docs/uesecuritytoken) Token) [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 retrieve the custom fields." }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "[ProductCategory](/docs/productcategory)", "0-1": "Returns an array of [ProductCategory](/docs/productcategory) objects containing information on the product categories" }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Exceptions" } [/block] The following exceptions (errors) are applicable to this method. [block:parameters] { "data": { "h-0": "", "0-1": "Message", "0-2": "Advice", "0-0": "Code" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim category() As eBizCharge.ProductCategory\n category = client.getProductCategories(token)\n MsgBox(category.Length)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": " try\n {\n eBizCharge.ProductCategory[] category = client.getProductCategories(token);\n MessageBox.Show(string.Concat(category.Length));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "Request:\n<?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:getProductCategories>\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</ns1:getProductCategories>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<SOAP-ENV:Envelope\nxmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\nxmlns:ns1=\"urn:eBizCharge\"\nxmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\nxmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\nxmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n <SOAP-ENV:Body>\n <ns1:getProductCategoriesResponse>\n <getProductCategoriesReturn SOAP-ENC:arrayType=\"ns1:ProductCategory[4]\" xsi:type=\"ns1:ProductCategoryArray\">\n <item xsi:type=\"ns1:ProductCategory\">\n <ProductCategoryRefNum xsi:type=\"xsd:string\">900100191</ProductCategoryRefNum>\n <Name xsi:type=\"xsd:string\">Books:Math</Name>\n </item>\n <item xsi:type=\"ns1:ProductCategory\">\n <ProductCategoryRefNum xsi:type=\"xsd:string\">900100193</ProductCategoryRefNum>\n <Name xsi:type=\"xsd:string\">Example Category</Name>\n </item>\n <item xsi:type=\"ns1:ProductCategory\">\n <ProductCategoryRefNum xsi:type=\"xsd:string\">900100194</ProductCategoryRefNum>\n <Name xsi:type=\"xsd:string\">Example Category</Name>\n </item>\n <item xsi:type=\"ns1:ProductCategory\">\n <ProductCategoryRefNum xsi:type=\"xsd:string\">900100192</ProductCategoryRefNum>\n <Name xsi:type=\"xsd:string\">Test Category</Name>\n </item>\n </getProductCategoriesReturn>\n </ns1:getProductCategoriesResponse>\n </SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]