This API call let's you retrieve the list of inventory settings. The response is an XML of the inventory settings.
Request Fields
| Field Name |
Type |
Required |
Description |
| action |
String |
Yes |
inventorySettings |
| accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
Response Fields
| Field Name |
Type |
Description |
| inventorySettings |
- |
XML structure |
| lowStockWarning |
Integer |
The low stock warning setting. |
| lowStockThreshold |
Integer |
The low stock threshold. |
| onlineStoreView |
Integer |
1 or 0. Whether the inventory can be viewed in the online store. |
| onlineStoreUpdate |
Integer |
1 or 0. Whether the inventory updates in the online store. |
| onlineStoreBackorder |
Integer |
1 or 0. Whether the inventory can be backordered in the online store. |
| payPageView |
Integer |
1 or 0. Whether the inventory can be viewed on the payment page. |
| payPageUpdate |
Integer |
1 or 0. Whether the inventory updates in the payment page. |
| payPageBackorder |
Integer |
1 or 0. Whether the inventory can be backordered in the payment page. |
| orderView |
Integer |
1 or 0. Whether the inventory can be viewed in the order. |
| orderUpdate |
Integer |
1 or 0. Whether the inventory updates in the order. |
| orderBackorder |
Integer |
1 or 0. Whether the inventory can be backordered in the order. |
| retailView |
Integer |
1 or 0. Whether the inventory can be viewed in the retail POS. |
| retailUpdate |
Integer |
1 or 0. Whether the inventory updates in the retail POS. |
| retailBackorder |
Integer |
1 or 0. Whether the inventory can be backordered in the retail POS. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code |
Error Code |
Message |
Description |
| 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. |
