{"_id":"5632a5e749e16d0d0012245c","__v":0,"project":"55b933b3146ef121002158d3","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"},"githubsync":"","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:41:50.498Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"This method adjusts the inventory for a product\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis method can be used to either adjust or set the inventory for a product. The product to update inventory for is selected by the ProductRefNum parameter which is assigned by the gateway when the product was added. Inventory levels for multiple warehouses (inventory locations) may be set at the same time. The Inventory parameter is an array of ProductInventory objects containing the new qty levels or adjustments to current levels. Warehouses that are not sent in the array are left as is. Quantaties sent as simple numbers will replace the existing quanties. If a ”+” or ”-” is sent before the number, the existing quantity will be either increased or decreased.\n\nFor example:\n## Starting Inventory\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"InventoryLocation\",\n    \"h-1\": \"QtyOnHand\",\n    \"h-2\": \"QtyOnOrder\",\n    \"0-0\": \"Los Angeles\",\n    \"0-1\": \"5\",\n    \"0-2\": \"200\",\n    \"1-0\": \"Washington DC\",\n    \"1-1\": \"10\",\n    \"1-2\": \"0\",\n    \"2-0\": \"New York\",\n    \"2-1\": \"123\",\n    \"2-2\": \"10\",\n    \"3-0\": \"Chicago\",\n    \"3-1\": \"24\",\n    \"3-2\": \"0\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n## Array of ProductInventory \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"InventoryLocation\",\n    \"h-1\": \"QtyOnHand\",\n    \"h-2\": \"QtyOnOrder\",\n    \"h-3\": \"DateAvailable\",\n    \"0-0\": \"Los Angeles\",\n    \"0-1\": \"+100\",\n    \"0-2\": \"-100\",\n    \"0-3\": \"8/10/2010\",\n    \"1-0\": \"Washington DC\",\n    \"1-1\": \"0\",\n    \"1-2\": \"19\",\n    \"1-3\": \"6/30/2010\",\n    \"2-3\": \"8/10/2010\",\n    \"2-0\": \"New York\",\n    \"2-1\": \"-13\",\n    \"2-2\": \"10\"\n  },\n  \"cols\": 4,\n  \"rows\": 3\n}\n[/block]\n## Ending Inventory \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"InventoryLocation\",\n    \"h-1\": \"QtyOnHand\",\n    \"h-2\": \"QtyOnOrder\",\n    \"0-0\": \"Los Angeles\",\n    \"0-1\": \"105\",\n    \"0-2\": \"100\",\n    \"1-0\": \"Washington DC\",\n    \"1-1\": \"0\",\n    \"1-2\": \"19\",\n    \"2-0\": \"New York\",\n    \"2-1\": \"110\",\n    \"2-2\": \"10\",\n    \"3-0\": \"Chicago\",\n    \"3-1\": \"24\",\n    \"3-2\": \"0\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Syntax\"\n}\n[/block]\n[ProductInventory](/docs/productinventory)[] **adjustInventory** ( [ueSecurityToken](/docs/uesecuritytoken), ProductRefNum, [ProductInventory](/docs/productinventory)[])\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\": \"[ProductInventory](/docs/productinventory)\",\n    \"2-1\": \"Inventory\",\n    \"2-2\": \"Array of ProductInventory objects containing qty or adjustments for each warehouse/inventory location\"\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\": \"[ProductInventory](/docs/productinventory)\",\n    \"0-1\": \"Returns an array of ProductInventory objects containing the adjusted inventory levels.\"\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## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim refNum As String\\n       refNum = \\\"9001169811\\\"\\n       Dim inventory(0 To 1) As eBizCharge.ProductInventory\\n       inventory(0) = New eBizCharge.ProductInventory()\\n       inventory(0).QtyOnHand = \\\"+100\\\"\\n       inventory(0).DateAvailable = \\\"2010-08-12\\\"\\n       Dim response() As eBizCharge.ProductInventory\\n       response = client.adjustInventory(token, refNum, inventory)\\n       MsgBox(response.Length)\",\n      \"language\": \"c\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"string RefNum = \\\"900116985\\\";\\n           eBizCharge.ProductInventory[] inventory = new eBizCharge.ProductInventory[1];\\n           inventory[0] = new eBizCharge.ProductInventory();\\n           inventory[0].QtyOnHand = \\\"+100\\\";\\n           inventory[0].DateAvailable = \\\"2010-08-12\\\";\\n           try\\n           {\\n               eBizCharge.ProductInventory[] response = client.adjustInventory(token, RefNum, inventory);\\n               MessageBox.Show(string.Concat(response.Length));\\n           }\\n           catch (Exception err)\\n           {\\n               MessageBox.Show(err.Message);\\n \\n \\n           }\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]\n## XML \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Request:\\nResponse:\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"adjustinventory","type":"basic","title":"adjustInventory"}
This method adjusts the inventory for a product [block:api-header] { "type": "basic", "title": "Description" } [/block] This method can be used to either adjust or set the inventory for a product. The product to update inventory for is selected by the ProductRefNum parameter which is assigned by the gateway when the product was added. Inventory levels for multiple warehouses (inventory locations) may be set at the same time. The Inventory parameter is an array of ProductInventory objects containing the new qty levels or adjustments to current levels. Warehouses that are not sent in the array are left as is. Quantaties sent as simple numbers will replace the existing quanties. If a ”+” or ”-” is sent before the number, the existing quantity will be either increased or decreased. For example: ## Starting Inventory [block:parameters] { "data": { "h-0": "InventoryLocation", "h-1": "QtyOnHand", "h-2": "QtyOnOrder", "0-0": "Los Angeles", "0-1": "5", "0-2": "200", "1-0": "Washington DC", "1-1": "10", "1-2": "0", "2-0": "New York", "2-1": "123", "2-2": "10", "3-0": "Chicago", "3-1": "24", "3-2": "0" }, "cols": 3, "rows": 4 } [/block] ## Array of ProductInventory [block:parameters] { "data": { "h-0": "InventoryLocation", "h-1": "QtyOnHand", "h-2": "QtyOnOrder", "h-3": "DateAvailable", "0-0": "Los Angeles", "0-1": "+100", "0-2": "-100", "0-3": "8/10/2010", "1-0": "Washington DC", "1-1": "0", "1-2": "19", "1-3": "6/30/2010", "2-3": "8/10/2010", "2-0": "New York", "2-1": "-13", "2-2": "10" }, "cols": 4, "rows": 3 } [/block] ## Ending Inventory [block:parameters] { "data": { "h-0": "InventoryLocation", "h-1": "QtyOnHand", "h-2": "QtyOnOrder", "0-0": "Los Angeles", "0-1": "105", "0-2": "100", "1-0": "Washington DC", "1-1": "0", "1-2": "19", "2-0": "New York", "2-1": "110", "2-2": "10", "3-0": "Chicago", "3-1": "24", "3-2": "0" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "Syntax" } [/block] [ProductInventory](/docs/productinventory)[] **adjustInventory** ( [ueSecurityToken](/docs/uesecuritytoken), ProductRefNum, [ProductInventory](/docs/productinventory)[]) [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": "[ProductInventory](/docs/productinventory)", "2-1": "Inventory", "2-2": "Array of ProductInventory objects containing qty or adjustments for each warehouse/inventory location" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "Return Value" } [/block] [block:parameters] { "data": { "0-0": "[ProductInventory](/docs/productinventory)", "0-1": "Returns an array of ProductInventory objects containing the adjusted inventory levels." }, "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 ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim refNum As String\n refNum = \"9001169811\"\n Dim inventory(0 To 1) As eBizCharge.ProductInventory\n inventory(0) = New eBizCharge.ProductInventory()\n inventory(0).QtyOnHand = \"+100\"\n inventory(0).DateAvailable = \"2010-08-12\"\n Dim response() As eBizCharge.ProductInventory\n response = client.adjustInventory(token, refNum, inventory)\n MsgBox(response.Length)", "language": "c" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "string RefNum = \"900116985\";\n eBizCharge.ProductInventory[] inventory = new eBizCharge.ProductInventory[1];\n inventory[0] = new eBizCharge.ProductInventory();\n inventory[0].QtyOnHand = \"+100\";\n inventory[0].DateAvailable = \"2010-08-12\";\n try\n {\n eBizCharge.ProductInventory[] response = client.adjustInventory(token, RefNum, inventory);\n MessageBox.Show(string.Concat(response.Length));\n }\n catch (Exception err)\n {\n MessageBox.Show(err.Message);\n \n \n }", "language": "csharp" } ] } [/block] ## XML [block:code] { "codes": [ { "code": "Request:\nResponse:", "language": "xml" } ] } [/block]