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 |
Syntax
boolean quickUpdateProduct ( ueSecurityToken Token, string ProductRefNum, FieldValue UpdateData )
Arguments
Type | Name | Description |
---|---|---|
ueSecurityToken | Token | Merchant security token: used to identify merchant and validate transaction. |
string | ProductRefNum | Gateway assigned product reference number used to update product. |
FieldValue | UpdateData | Array of fields to be updated. |
Return Value
Type | Description |
---|---|
boolean | Returns confirmation of request only if successful. If request fails, an exception will be thrown. |