developer:soap-1.6:methods:quickupdateproduct

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

developer:soap-1.6:methods:quickupdateproduct [2012/08/04 11:15] (current)
tem created
Line 1: Line 1:
 +<embed ..:​contents/>​====== quickUpdateProduct ======
 +
 +Update product data in selected fields only.
 +
 +
 +
 +
 +===== Description =====
 +
 +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]] 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: ​
 +
 +^Type    ^Name    ^Description ​   ^
 +|string |ProductID |Merchant assigned product ID |
 +|integer |CategoryID |Merchant assigned category ID |
 +|string |SKU |Stock-Keeping Unit|
 +|string |UPC |Universal Product Code|
 +|boolean |Enabled |Enables the ability to store products |
 +|string |Name |Name of the product |
 +|string |Description |Product description |
 +|string |Model |Model of the product |
 +|double |Weight |Weight of the product |
 +|double |ShipWeight |Shipping weight of the product |
 +|double |Price |Price of the product |
 +|double |WholesalePrice |Wholesale price of the product |
 +|double |ListPrice |List price of the product |
 +|string |DateAvailable |Date the product is available for sale |
 +|string |Manufacturer |Maker of the product |
 +|boolean |PhysicalGood |Tangible/​Shippable good. |
 +|integer |MinQuantity |Minimum quantity allowed |
 +|integer |MaxQuantity |Maximum quantity allowed |
 +|string |ImageURL |URL address of the product image |
 +|string |URL |URL of the product |
 +
 +
 +See also [[TBA]], [[TBA]]
 +
 +===== Syntax =====
 +
 +boolean **quickUpdateProduct** ( [[..:​objects:​ueSecurityToken]] Token, integer ProductRefNum,​ [[..:​objects:​FieldValue]] UpdateData ) 
 +
 +
 +===== Arguments =====
 +
 +^Type    ^Name    ^Description ​   ^
 +|[[..:​objects:​ueSecurityToken]] |Token |Merchant security token: used to identify merchant and validate transaction.|
 +|integer |CustNum |A unique customer number assigned by the gateway.|
 +|[[..:​objects:​FieldValue]] |UpdateData |Array of fields to be updated. |
 +
 +
 +
 +===== Return Value =====
 +
 +|boolean |Returns confirmation of request only if successful. If request fails, an exception will be thrown.|
 +
 +===== Examples =====
 +
 +
 +==== PHP ====
 +
 +For directions on how to set up the WSDL link, create "​$token"​ and "​$client",​ go to [[..:​howto:​php|PHP Soap How-to]].
 +
 +<code php>
 +<?​php ​
 +
 +TBA
 +?>  ​
 +</​code>​
 +
 +
 +==== Java ====
 +
 +This example uses the [[developer/​javalibrary|USAePay Java library]]. ​ For directions on how to install the library and create the token/​client objects, go to either the [[..:​howto:​javajaxrpc|Java JAX-RPC Howto]] or the [[..:​howto:​javajaxws|Java JAX-WS Howto]].
 +
 +
 +<code java>
 +TBA
 +</​code>​
 +
 +
 + 
 + 
 + 
  
developer/soap-1.6/methods/quickupdateproduct.txt ยท Last modified: 2012/08/04 11:15 by tem

Page Tools