Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Settings »

Point-of-Sale Settings

This API call let's you retrieve the list of POS settings. The response is an XML of the POS settings.

Request Fields

Field Name Type Required Description
action String Yes posSettings
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
posSettings - XML structure
enabled Integer 1 or 0. Whether the POS is enabled or not.
locationCountry String The country the POS is located in.
locationPorvince String The province the POS is located in.
allowDiscounts Integer 1 or 0. Whether the POS allows discounts.
currency String The currency the POS uses.
terminalId Integer The terminal ID.
posLayoutId Integer The POS layout ID.
tax - XML structure
name String The name of the applicable tax.
rate Decimal The tax rate applied.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description

Code Samples

Sample POS Settings Response XML

<?xml version="1.0"?>
<posSettings>
    <enabled>1</enabled>
    <locationCountry>Canada</locationCountry>
    <locationProvince>Alberta</locationProvince>
    <allowDiscounts>1</allowDiscounts>
    <currency>CAD</currency>
    <terminalId>13</terminalId>
    <posLayoutId>340</posLayoutId>
    <tax>
        <name>GST 5.00%</name>
        <rate>5.0000</rate>
    </tax>
</posSettings>

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="posSettings">