This API call lets you update the inventory of a specific product. The response is an XML of the inventory update.
Request Fields
| Field Name |
Type |
Required |
Description |
| action |
String |
Yes |
inventoryUpdate |
| accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
| productId |
Integer |
Yes |
The product ID. |
| stockChange |
Integer |
Yes |
The amount of units the inventory is changing by (- for decrease). |
| note |
String |
Yes |
The description of the inventory change. |
Response Fields
| Field Name |
Type |
Description |
| message |
- |
XML structure |
| response |
Integer |
1 or 0. Whether the product inventory was updated or not. |
| responseMessage |
String |
Confirmation of completed inventory update. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code |
Error Code |
Message |
Description |
| 0 |
- |
Missing Field - Note |
Note entry is blank. |
| 0 |
- |
Missing Field - Stock Change |
Stock Change entry is blank. |
| 0 |
- |
Invalid API Token1 |
The API Token is invalid, or not entered. |
| 0 |
- |
Missing or Invalid Fields - Account ID |
The Account ID is invalid, or not entered. |
