POS API

 

 

Accessed by selecting the POS API option in the Server Type drop down list.

Used to configure the settings required for the POS API Interface. The POS API (POS.Gateway.Client.exe) interface is used to process OrderAway and TouchMini Orders/Sales.

 

 

Noteworthy 

• Port - Defaults to 33300.

 

 

• Return Receipt Text - It is recommended that this is always selected. Select to ensure that receipt information is retrieved from Touch and returned in the form of text.
  • Max Width - Default is 32 characters. Displays/Enter the maximum width in characters of the generated Receipt.

 

 

• Return Receipt Image - It is recommended that this is always selected. Select to ensure that receipt information is retrieved from Touch and returned in the form of an image file. Once selected, and the Receipt Peripheral:
  • Is configured as Non-Graphical, then the POS API will return a Receipt Image with a default header and footer using the following variables:
    • Header
      • {DOCKET TYPE}
      • {TRADING NAME}
      • {ABNDescription}: {ABN}
      • --------------------------------------
    • Footer
      • Receipt #: {RECEIPT #}
      • Date: {LASTACTIVITYDATE} Time: {LASTACTIVITYTIME}
      • Clerk: {CLERK #} {CLERK NAME}
      • Terminal: {TERMINAL ID} {TERMINAL NAME}

 

 

An example of the default Receipt returned.

 

• Return Receipt Image continued ...
  • Is configured as Graphical and then changed to Non-Graphical, the POS API will still return a Receipt Image based on the previous Graphical configuration. To ensure it returns Receipt Image with a default header and footer (as per above), then temporarily select the Use Graphical Printing option and clear all content in the Header and Footer and save the changes. Then unselect the Use Graphical Printing option and save again. The POS API will now return a Receipt Image with a default header and footer.

 

 

• Open Port for All Users - Select to ensure that all users regardless of their authorisation level (Admin rights) can run the selected Server Type. In this case POS API. By adding this option it ensures Apps are running with the highest authorisation level if required. For example, POS API requires Admin level authorisation, then make sure the required windows users are placed in the Administrative group. Application titles will append (Administrator) to the end to indicate the mode.

• URLs - Displays the URLs that need to be provided to the Client/Provider when configuring a new Web Server.

 

 

 

End of article.      ▲