Helcim Commerce API » Settings »

Inventory Settings

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 (XML)

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

Code Samples

XML Sample Inventory Settings Response

HTML HTML Form Sample

Sample Inventory Settings Response XML

<?xml version="1.0"?>
<inventorySettings>
    <lowStockWarning>0</lowStockWarning>
    <lowStockThreshold>100</lowStockThreshold>
    <onlineStoreView>1</onlineStoreView>
    <onlineStoreUpdate>1</onlineStoreUpdate>
    <onlineStoreBackorder>1</onlineStoreBackorder>
    <payPageView>1</payPageView>
    <payPageUpdate>1</payPageUpdate>
    <payPageBackorder>1</payPageBackorder>
    <orderView>1</orderView>
    <orderUpdate>1</orderUpdate>
    <orderBackorder>1</orderBackorder>
    <retailView>0</retailView>
    <retailUpdate>1</retailUpdate>
    <retailBackorder>1</retailBackorder>
</inventorySettings>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="action" value="inventorySettings">