{"_id":"5632a5e749e16d0d00122454","githubsync":"","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"},"project":"55b933b3146ef121002158d3","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,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:39:55.805Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Update product data in selected fields only.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method allows you to update only specified data for a product record, rather than replacing all existing data.\nThis method requires the use of the ProductRefNum, a unique product number assigned by the gateway. If you have lost or cannot remember the products's ProductRefNum, use the [searchProducts](/docs/searchproducts) method to find the correct ProductRefNum.\nThis method uses the UpdateData array containing the fields that you would like to update. The “key” of each element is the name of the field you wish to change and the “value” of the element is the new value that you would like to assign.\nThe following fields may be updated using this method:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"string\",\n    \"0-1\": \"ProductID\",\n    \"0-2\": \"Merchant assigned product ID\",\n    \"1-0\": \"integer\",\n    \"1-1\": \"CategoryID\",\n    \"1-2\": \"Merchant assigned category ID\",\n    \"2-0\": \"string\",\n    \"2-1\": \"SKU\",\n    \"2-2\": \"Stock-Keeping Unit\",\n    \"3-0\": \"string\",\n    \"3-1\": \"UPC\",\n    \"3-2\": \"Universal Product Code\",\n    \"4-0\": \"boolean\",\n    \"4-1\": \"Enabled\",\n    \"4-2\": \"Enables the ability to store products\",\n    \"5-0\": \"string\",\n    \"5-1\": \"Name\",\n    \"5-2\": \"Name of the product\",\n    \"6-0\": \"string\",\n    \"6-1\": \"Description\",\n    \"6-2\": \"Product description\",\n    \"7-0\": \"string\",\n    \"7-1\": \"Model\",\n    \"7-2\": \"Model of the product\",\n    \"8-0\": \"double\",\n    \"8-1\": \"Weight\",\n    \"8-2\": \"Weight of the product\",\n    \"9-0\": \"double\",\n    \"9-1\": \"ShipWeight\",\n    \"9-2\": \"Shipping weight of the product\",\n    \"10-0\": \"double\",\n    \"10-1\": \"Price\",\n    \"10-2\": \"Price of the product\",\n    \"11-0\": \"double\",\n    \"11-1\": \"WholesalePrice\",\n    \"11-2\": \"Wholesale price of the product\",\n    \"12-0\": \"double\",\n    \"12-1\": \"ListPrice\",\n    \"12-2\": \"List price of the product\",\n    \"13-0\": \"string\",\n    \"13-1\": \"DateAvailable\",\n    \"13-2\": \"Date the product is available for sale\",\n    \"14-0\": \"string\",\n    \"14-1\": \"Manufacturer\",\n    \"14-2\": \"Maker of the product\",\n    \"15-0\": \"boolean\",\n    \"15-1\": \"PhysicalGood\",\n    \"15-2\": \"Tangible/Shippable good.\",\n    \"16-0\": \"integer\",\n    \"16-1\": \"MinQuantity\",\n    \"16-2\": \"Minimum quantity allowed\",\n    \"17-0\": \"integer\",\n    \"17-1\": \"MaxQuantity\",\n    \"17-2\": \"Maximum quantity allowed\",\n    \"18-0\": \"string\",\n    \"18-1\": \"ImageURL\",\n    \"18-2\": \"URL address of the product image\",\n    \"19-0\": \"string\",\n    \"19-1\": \"URL\",\n    \"19-2\": \"URL of the product\"\n  },\n  \"cols\": 3,\n  \"rows\": 20\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\nboolean **quickUpdateProduct** ( [ueSecurityToken]/docs/uesecuritytoken) Token, integer ProductRefNum, [FieldValue](/docs/fieldvalue) UpdateData )\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\": \"integer\",\n    \"1-1\": \"CustNum\",\n    \"1-2\": \"A unique customer number assigned by the gateway.\",\n    \"2-0\": \"[FieldValue](/docs/fieldvalue)\",\n    \"2-1\": \"UpdateData\",\n    \"2-2\": \"Array of fields to be updated.\"\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 confirmation of request only if successful. If request fails, an exception will be thrown.\"\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\\nTBA\\n?>\",\n      \"language\": \"php\"\n    }\n  ]\n}\n[/block]\n## Java \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"TBA\",\n      \"language\": \"java\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"quickupdateproduct","type":"basic","title":"quickUpdateProduct"}

quickUpdateProduct


Update product data in selected fields only. [block:api-header] { "type": "basic", "title": "Description" } [/block] This method allows you to update only specified data for a product record, rather than replacing all existing data. This method requires the use of the ProductRefNum, a unique product number assigned by the gateway. If you have lost or cannot remember the products's ProductRefNum, use the [searchProducts](/docs/searchproducts) method to find the correct ProductRefNum. This method uses the UpdateData array containing the fields that you would like to update. The “key” of each element is the name of the field you wish to change and the “value” of the element is the new value that you would like to assign. The following fields may be updated using this method: [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "ProductID", "0-2": "Merchant assigned product ID", "1-0": "integer", "1-1": "CategoryID", "1-2": "Merchant assigned category ID", "2-0": "string", "2-1": "SKU", "2-2": "Stock-Keeping Unit", "3-0": "string", "3-1": "UPC", "3-2": "Universal Product Code", "4-0": "boolean", "4-1": "Enabled", "4-2": "Enables the ability to store products", "5-0": "string", "5-1": "Name", "5-2": "Name of the product", "6-0": "string", "6-1": "Description", "6-2": "Product description", "7-0": "string", "7-1": "Model", "7-2": "Model of the product", "8-0": "double", "8-1": "Weight", "8-2": "Weight of the product", "9-0": "double", "9-1": "ShipWeight", "9-2": "Shipping weight of the product", "10-0": "double", "10-1": "Price", "10-2": "Price of the product", "11-0": "double", "11-1": "WholesalePrice", "11-2": "Wholesale price of the product", "12-0": "double", "12-1": "ListPrice", "12-2": "List price of the product", "13-0": "string", "13-1": "DateAvailable", "13-2": "Date the product is available for sale", "14-0": "string", "14-1": "Manufacturer", "14-2": "Maker of the product", "15-0": "boolean", "15-1": "PhysicalGood", "15-2": "Tangible/Shippable good.", "16-0": "integer", "16-1": "MinQuantity", "16-2": "Minimum quantity allowed", "17-0": "integer", "17-1": "MaxQuantity", "17-2": "Maximum quantity allowed", "18-0": "string", "18-1": "ImageURL", "18-2": "URL address of the product image", "19-0": "string", "19-1": "URL", "19-2": "URL of the product" }, "cols": 3, "rows": 20 } [/block] [block:api-header] { "type": "basic", "title": "Syntax" } [/block] boolean **quickUpdateProduct** ( [ueSecurityToken]/docs/uesecuritytoken) Token, integer ProductRefNum, [FieldValue](/docs/fieldvalue) UpdateData ) [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": "integer", "1-1": "CustNum", "1-2": "A unique customer number assigned by the gateway.", "2-0": "[FieldValue](/docs/fieldvalue)", "2-1": "UpdateData", "2-2": "Array of fields to be updated." }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "boolean", "0-1": "Returns confirmation of request only if successful. If request fails, an exception will be thrown." }, "cols": 2, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## PHP [block:code] { "codes": [ { "code": "<?php\nTBA\n?>", "language": "php" } ] } [/block] ## Java [block:code] { "codes": [ { "code": "TBA", "language": "java" } ] } [/block]