{"_id":"5632a5e749e16d0d00122453","__v":0,"githubsync":"","project":"55b933b3146ef121002158d3","user":"55b932ba8fd1a02b00f496c8","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"},"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"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:39:41.311Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"This method updates an existing product.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nUpdates an existing product based on its ProductRefNum. The entire product is replaced by the contents of the Product parameter. Developers can use the getProduct method to retrieve the Product object, modify a field and then post the object back to the server. If you only need to update one field, consider using the quickUpdateProduct method instead.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nboolean **updateProduct** ( [ueSecurityToken](/docs/uesecuritytoken), ProductRefNum, [Product](/docs/product))\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    \"1-0\": \"string\",\n    \"1-1\": \"ProductRefNum\",\n    \"1-2\": \"Product reference number (gateway assigned)\",\n    \"2-0\": \"[Product]/docs/product)\",\n    \"2-1\": \"Product\",\n    \"2-2\": \"Product data\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\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\": \"boolean\",\n    \"0-1\": \"Returns a true if the product is updated correctly\"\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\": \"Code\",\n    \"h-1\": \"Message\",\n    \"h-2\": \"Advice\",\n    \"0-0\": \"41002\",\n    \"0-1\": \"Product Not Found\",\n    \"0-2\": \"Product specified by ProductRefNum was not found. Make sure the number stored is not truncated or rounded.\",\n    \"1-0\": \"41003\",\n    \"1-1\": \"Error saving product\",\n    \"1-2\": \"A database fault was encountered while saving product record. Try operation again or contact support\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\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                       $Product = array(\\n                       \\\"ProductID\\\" => \\\"0-13-508011-8\\\",\\n                       \\\"SKU\\\" =>\\\"135080118\\\",\\n                       \\\"UPC\\\" => \\\"9780135080115\\\",\\n                       \\\"Category\\\" => \\\"Books:Math\\\",\\n                       \\\"Enabled\\\" => true,\\n                       \\\"Name\\\" => \\\"Elementary Differential Equations\\\",\\n                       \\\"Description\\\" => \\\"Rainville, Bedient and Bedient (Eight Edition)\\\",\\n                       \\\"Weight\\\" => 1.0,\\n                       \\\"ShipWeight\\\" => 1.1,\\n                       \\\"Price\\\" => 112.00,\\n                       \\\"ListPrice\\\" =>  128.00,\\n                       \\\"WholesalePrice\\\"=> 100.00,\\n                       \\\"DateAvailable\\\" => \\\"2009-12-01\\\",\\n                       \\\"Manufacturer\\\" => \\\"Prentice Hall\\\",\\n                       \\\"Type\\\" => \\\"Unknown\\\",\\n                       \\\"MinQuantity\\\" =>0,\\n                       \\\"MaxQuantity\\\" =>10,\\n                       \\\"ImageURL\\\" => \\\"http://acme.com/prodimg/123123.jpg\\\",\\n                       \\\"URL\\\" => \\\"http:/acme.com/prod/123123.html\\\"\\n               );\\n               $client->updateProduct($token, $ProductRefNum, $Product);\\n}\\ncatch(SoapFault $e) {\\n echo $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 RefNum As String\\n       RefNum = \\\"9001169810\\\"\\n       Dim product As eBizCharge.Product = New eBizCharge.Product()\\n       product.ProductID = \\\"0-13-508011-8\\\"\\n       product.SKU = \\\"135080118\\\"\\n       product.UPC = \\\"9780135080115\\\"\\n       product.Category = \\\"Books:Science\\\"\\n       product.Enabled = True\\n       product.Name = \\\"Non-Elementary Differential Equations\\\"\\n       product.Description = \\\"Rainville, Bedient and Bedient (Eight Edition)\\\"\\n       product.Weight = 1.0\\n       product.ShipWeight = 1.1\\n       product.Price = 112.0\\n       product.ListPrice = 128.0\\n       product.WholesalePrice = 100.0\\n       product.DateAvailable = \\\"2010-08-01\\\"\\n       product.Manufacturer = \\\"Prentice Hail\\\"\\n       product.MinQuantity = \\\"0\\\"\\n       Dim response As Boolean\\n       response = client.updateProduct(token, RefNum, product)\\n       MsgBox(response)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string RefNum = \\\"900116982\\\";\\n           eBizCharge.Product product = new eBizCharge.Product();\\n           product.ProductID = \\\"0-13-508011-8\\\";\\n           product.SKU = \\\"135080118\\\";\\n           product.UPC = \\\"9780135080115\\\";\\n           product.Category = \\\"Books:Science\\\";\\n           product.Enabled = true;\\n           product.Name = \\\"Elementary Differential Equations\\\";\\n           product.Description = \\\"Rainville, Bedient and Bedient (Eight Edition)\\\";\\n           product.Weight = 1.0;\\n           product.ShipWeight = 1.1;\\n           product.Price = 112.00;\\n           product.ListPrice = 128.00;\\n           product.WholesalePrice = 100.00;\\n           product.DateAvailable = \\\"2010-08-01\\\";\\n           product.Manufacturer = \\\"Prentice Hail\\\";\\n           product.MinQuantity = \\\"0\\\";\\n           Boolean response;\\n           try\\n           {\\n               response = client.updateProduct(token, RefNum, product);\\n               MessageBox.Show(string.Concat(response));\\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\\n       xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n       xmlns:ns1=\\\"urn:eBizCharge\\\"\\n       xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n       xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n       xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n       SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:updateProduct>\\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<ProductRefNum xsi:type=\\\"xsd:string\\\">9011780623</ProductRefNum>\\n<Product xsi:type=\\\"ns1:Product\\\">\\n <ProductID xsi:type=\\\"xsd:string\\\">0-13-508011-8</ProductID>\\n <SKU xsi:type=\\\"xsd:string\\\">135080118</SKU>\\n <UPC xsi:type=\\\"xsd:string\\\">9780135080115</UPC>\\n <Category xsi:type=\\\"xsd:string\\\">Books:Math</Category>\\n <Enabled xsi:type=\\\"xsd:boolean\\\">true</Enabled>\\n <Name xsi:type=\\\"xsd:string\\\">A new Product Name</Name>\\n <Description xsi:type=\\\"xsd:string\\\">Rainville, Bedient and Bedient (Eight Edition)</Description>\\n <Weight xsi:type=\\\"xsd:double\\\">1</Weight>\\n <ShipWeight xsi:type=\\\"xsd:double\\\">1.1</ShipWeight>\\n <Price xsi:type=\\\"xsd:double\\\">112</Price>\\n <WholesalePrice xsi:type=\\\"xsd:double\\\">100</WholesalePrice>\\n <ListPrice xsi:type=\\\"xsd:double\\\">128</ListPrice>\\n <DateAvailable xsi:type=\\\"xsd:string\\\">2009-12-01</DateAvailable>\\n <Manufacturer xsi:type=\\\"xsd:string\\\">Prentice Hall</Manufacturer>\\n <MinQuantity xsi:type=\\\"xsd:integer\\\">0</MinQuantity>\\n <MaxQuantity xsi:type=\\\"xsd:integer\\\">10</MaxQuantity>\\n <ImageURL xsi:type=\\\"xsd:string\\\">http://acme.com/prodimg/123123.jpg</ImageURL>\\n <URL xsi:type=\\\"xsd:string\\\">http:/acme.com/prod/123123.html</URL>\\n</Product>\\n</ns1:updateProduct>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\\nResponse:\\n<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<SOAP-ENV:Envelope\\n       xmlns:SOAP-ENV=\\\"http://schemas.xmlsoap.org/soap/envelope/\\\"\\n       xmlns:ns1=\\\"urn:eBizCharge\\\"\\n       xmlns:xsd=\\\"http://www.w3.org/2001/XMLSchema\\\"\\n       xmlns:xsi=\\\"http://www.w3.org/2001/XMLSchema-instance\\\"\\n       xmlns:SOAP-ENC=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\"\\n       SOAP-ENV:encodingStyle=\\\"http://schemas.xmlsoap.org/soap/encoding/\\\">\\n<SOAP-ENV:Body>\\n<ns1:updateProductResponse>\\n       <updateProductReturn xsi:type=\\\"xsd:boolean\\\">true</updateProductReturn>\\n</ns1:updateProductResponse>\\n</SOAP-ENV:Body>\\n</SOAP-ENV:Envelope>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"update-product","type":"basic","title":"updateProduct"}
This method updates an existing product. [block:api-header] { "type": "basic", "title": "Description" } [/block] Updates an existing product based on its ProductRefNum. The entire product is replaced by the contents of the Product parameter. Developers can use the getProduct method to retrieve the Product object, modify a field and then post the object back to the server. If you only need to update one field, consider using the quickUpdateProduct method instead. [block:api-header] { "type": "basic", "title": "Syntax" } [/block] boolean **updateProduct** ( [ueSecurityToken](/docs/uesecuritytoken), ProductRefNum, [Product](/docs/product)) [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.", "1-0": "string", "1-1": "ProductRefNum", "1-2": "Product reference number (gateway assigned)", "2-0": "[Product]/docs/product)", "2-1": "Product", "2-2": "Product data" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "boolean", "0-1": "Returns a true if the product is updated correctly" }, "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": "Code", "h-1": "Message", "h-2": "Advice", "0-0": "41002", "0-1": "Product Not Found", "0-2": "Product specified by ProductRefNum was not found. Make sure the number stored is not truncated or rounded.", "1-0": "41003", "1-1": "Error saving product", "1-2": "A database fault was encountered while saving product record. Try operation again or contact support" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\ntry {\n $Product = array(\n \"ProductID\" => \"0-13-508011-8\",\n \"SKU\" =>\"135080118\",\n \"UPC\" => \"9780135080115\",\n \"Category\" => \"Books:Math\",\n \"Enabled\" => true,\n \"Name\" => \"Elementary Differential Equations\",\n \"Description\" => \"Rainville, Bedient and Bedient (Eight Edition)\",\n \"Weight\" => 1.0,\n \"ShipWeight\" => 1.1,\n \"Price\" => 112.00,\n \"ListPrice\" => 128.00,\n \"WholesalePrice\"=> 100.00,\n \"DateAvailable\" => \"2009-12-01\",\n \"Manufacturer\" => \"Prentice Hall\",\n \"Type\" => \"Unknown\",\n \"MinQuantity\" =>0,\n \"MaxQuantity\" =>10,\n \"ImageURL\" => \"http://acme.com/prodimg/123123.jpg\",\n \"URL\" => \"http:/acme.com/prod/123123.html\"\n );\n $client->updateProduct($token, $ProductRefNum, $Product);\n}\ncatch(SoapFault $e) {\n echo $e->getMessage();\n}\n?>", "language": "php" } ] } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim RefNum As String\n RefNum = \"9001169810\"\n Dim product As eBizCharge.Product = New eBizCharge.Product()\n product.ProductID = \"0-13-508011-8\"\n product.SKU = \"135080118\"\n product.UPC = \"9780135080115\"\n product.Category = \"Books:Science\"\n product.Enabled = True\n product.Name = \"Non-Elementary Differential Equations\"\n product.Description = \"Rainville, Bedient and Bedient (Eight Edition)\"\n product.Weight = 1.0\n product.ShipWeight = 1.1\n product.Price = 112.0\n product.ListPrice = 128.0\n product.WholesalePrice = 100.0\n product.DateAvailable = \"2010-08-01\"\n product.Manufacturer = \"Prentice Hail\"\n product.MinQuantity = \"0\"\n Dim response As Boolean\n response = client.updateProduct(token, RefNum, product)\n MsgBox(response)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string RefNum = \"900116982\";\n eBizCharge.Product product = new eBizCharge.Product();\n product.ProductID = \"0-13-508011-8\";\n product.SKU = \"135080118\";\n product.UPC = \"9780135080115\";\n product.Category = \"Books:Science\";\n product.Enabled = true;\n product.Name = \"Elementary Differential Equations\";\n product.Description = \"Rainville, Bedient and Bedient (Eight Edition)\";\n product.Weight = 1.0;\n product.ShipWeight = 1.1;\n product.Price = 112.00;\n product.ListPrice = 128.00;\n product.WholesalePrice = 100.00;\n product.DateAvailable = \"2010-08-01\";\n product.Manufacturer = \"Prentice Hail\";\n product.MinQuantity = \"0\";\n Boolean response;\n try\n {\n response = client.updateProduct(token, RefNum, product);\n MessageBox.Show(string.Concat(response));\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\n xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:updateProduct>\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<ProductRefNum xsi:type=\"xsd:string\">9011780623</ProductRefNum>\n<Product xsi:type=\"ns1:Product\">\n <ProductID xsi:type=\"xsd:string\">0-13-508011-8</ProductID>\n <SKU xsi:type=\"xsd:string\">135080118</SKU>\n <UPC xsi:type=\"xsd:string\">9780135080115</UPC>\n <Category xsi:type=\"xsd:string\">Books:Math</Category>\n <Enabled xsi:type=\"xsd:boolean\">true</Enabled>\n <Name xsi:type=\"xsd:string\">A new Product Name</Name>\n <Description xsi:type=\"xsd:string\">Rainville, Bedient and Bedient (Eight Edition)</Description>\n <Weight xsi:type=\"xsd:double\">1</Weight>\n <ShipWeight xsi:type=\"xsd:double\">1.1</ShipWeight>\n <Price xsi:type=\"xsd:double\">112</Price>\n <WholesalePrice xsi:type=\"xsd:double\">100</WholesalePrice>\n <ListPrice xsi:type=\"xsd:double\">128</ListPrice>\n <DateAvailable xsi:type=\"xsd:string\">2009-12-01</DateAvailable>\n <Manufacturer xsi:type=\"xsd:string\">Prentice Hall</Manufacturer>\n <MinQuantity xsi:type=\"xsd:integer\">0</MinQuantity>\n <MaxQuantity xsi:type=\"xsd:integer\">10</MaxQuantity>\n <ImageURL xsi:type=\"xsd:string\">http://acme.com/prodimg/123123.jpg</ImageURL>\n <URL xsi:type=\"xsd:string\">http:/acme.com/prod/123123.html</URL>\n</Product>\n</ns1:updateProduct>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>\nResponse:\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<SOAP-ENV:Envelope\n xmlns:SOAP-ENV=\"http://schemas.xmlsoap.org/soap/envelope/\"\n xmlns:ns1=\"urn:eBizCharge\"\n xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"\n xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"\n xmlns:SOAP-ENC=\"http://schemas.xmlsoap.org/soap/encoding/\"\n SOAP-ENV:encodingStyle=\"http://schemas.xmlsoap.org/soap/encoding/\">\n<SOAP-ENV:Body>\n<ns1:updateProductResponse>\n <updateProductReturn xsi:type=\"xsd:boolean\">true</updateProductReturn>\n</ns1:updateProductResponse>\n</SOAP-ENV:Body>\n</SOAP-ENV:Envelope>", "language": "xml" } ] } [/block]