Gift Cards / Promotions / Vouchers
      Back to home
      1. swiftpos Help Guides
      2. 3rd Party Integrations
      3. Gift Cards / Promotions / Vouchers

      Zen Global

      3rd Party Integration with swiftpos NetPOS

      zen-global-logo

      Refer HERE for Reseller & Support information.

       

      This outlines the information and the steps that are needed to familiarise oneself with the Zen Global interface.

      The content is targeted at Resellers and swiftpos Venue Administrators who have a sound knowledge of and experience with swiftpos. For further information or assistance, please contact your swiftpos Reseller or swiftpos Support.

       

      Subjects      ▼

           

          Frequent Shopper Offers      ▲ ▼

           

          About      ▲ ▼

           

          What Is It?      ▲ ▼

          Zen Global specialises in cloud-based Loyalty and Marketing, Sales Reporting, Gift Card/Voucher and Display Screen Software. From a swiftpos perspective, this enhanced interface facilitates the implementation and use of Zen Global Frequent Shopper Offers at a Venue.

          Zen Global is owned by Liquor Marketing Group (LMG).

           

          What Is Required?      ▲ ▼

          • swiftpos V10.73+
          • A NetPOS registration for Zen Global.
          • Ensure the credentials required for a connection to Zen Global's API to be successful, has been obtained from Zen Global.

           

          What Is Supported?      ▲ ▼

          • The following offer types are supported:


          Offer Type

          Description

          Percentage Off

          Can apply to Items or Total Sale

          Dollar Amount

          Can apply to Items or Total Sale

          Price Change

          Applies to Items Only

           

          When Is It Used?      ▲ ▼

          This integration is required when a Venue intends to offer Zen Global Frequent Shopper Offers to patrons, as a reward for their loyalty.

           

          How To?      ▲ ▼

           

          How To GET STARTED?      ▲ ▼

          Do as follows:

           

          How To Configure Back Office?      ▲ ▼

          If the Venue is also implementing the swiftpos Zen Global Gift Card/Voucher interface, the steps outlined for configuring the Back Office HERE will have to be completed.

           

          How To Configure NetPOS?      ▲ ▼

          Once the above requirements have been met, then the following will need to be done:

           

          Configure The swiftpos Back Office Interface?      ▲ ▼

          Back Office settings will need to be configured. To do this, do as follows:

           

          Configure The Zen Global Interface?      ▲ ▼

          Zen Global settings will need to be configured. To do this, do as follows:

          • First ensure the steps outlined for configuring the Zen Global interface in NetPOS HERE have been completed.
          • Then, with the Zen Global interface selected in NetPOS and the Settings tab selected, ensure:
            • The Get Offers option is selected to ensure any offers are returned when a Customer's Frequent Shopper ID is entered/scanned at Touch. Refer to How To Get Offers for more information.
            • If required, ensure the Apply Discount To Media option is enabled and then enter the ID of the Media to which the Offer discount will be assigned. This can be helpful when it comes to reporting. Refer to the Sales Media reports.

           

          How To Configure Touch?      ▲ ▼

          Touch will need to be configured to ensure Zen Global Frequent Shopper Offers can be retrieved and customer loyalty points can be redeemed. To do this:

          • Ensure the following POS Keys are added to the appropriate Keyboard Layout via the Designer. Refer to Add A POS Key To A Keyboard Layout for more information.
            • Charge / Redemption (#151) - Ensure the POS Key is configured to ensure the interface selected is Zen Global and its caption is appropriately labelled. For example, Redeem ZG Loyalty Points.
            • Customer (#102) - Ensure the POS Key is configured to ensure the interface selected is Zen Global and its caption is appropriately labelled. For example, ZG Customer.
          • Ensure the POS Keys, added above, are configured appropriately to meet the Venue's requirements.
          • Ensure a Full Update is sent to all Touch Terminals that make use of the same Keyboard Layout to which the above POS Keys were added.

           

          Gift Cards / Vouchers      ▲ ▼

           

          About      ▲ ▼

           

          What Is It?      ▲ ▼

          Zen Global specialises in cloud-based Loyalty and Marketing, Sales Reporting, Gift Card/Voucher and Display Screen Software. From a swiftpos perspective, this enhanced interface facilitates the implementation and use of Zen Global Gift Cards/Vouchers at a Venue.

          Zen Global is owned by Liquor Marketing Group (LMG).

           

          What Is Not Supported?      ▲ ▼

          • The recharging/topping up and the redemption of the same Gift Card/Voucher in the same sale is NOT supported.

           

          What Is Required?      ▲ ▼

          • swiftpos V10.67+
          • A NetPOS registration for Zen Global.
          • Ensure the credentials required for a connection to Zen Global's API to be successful, has been obtained from Zen Global.

           

          What Is Supported?      ▲ ▼

          • A Gift Card/Voucher can only be redeemed up to the available balance amount.
          • A recharge/top up can only be refunded up to the available balance amount.

           

          What To Consider?      ▲ ▼

          • When refunding the redemption of a Gift Card/Voucher, no balance check is done prior to the refund. That means the refund will proceed regardless of whether the Gift Card/Voucher's balance is zero.
          • The limitations that were present with the Zen Global interface in swiftpos releases prior to V10.64, are NO LONGER APPLICABLE in swiftpos releases V10.64+. These are:
            • Since the Gift Card/Voucher card is searched in Zen Global before swiftpos knows whether the action will be a recharge or redemption, this means that:
              • The Reserve API call is not used on the initial search.
              • The Search method is a partial match and can return multiple cards.

           

          When Is It Used?      ▲ ▼

          The Zen Global Gift Card/Voucher swiftpos integration used when Venues want to integrate with Zen Global and offer their patrons, Zen Global Gift Card/Voucher services. For example:

          • Sell Pre-Encoded Gift Cards/Vouchers at POS.*
          • Enquire into a Gift Card's/Voucher's Balance.*
          • Redeem a Gift Card/Voucher.*
          • Email Gift Cards/Vouchers at POS and potentially add a Surcharge.
          • Add a Surcharge when selling Gift Cards/Vouchers.
          • Redeem a Gift Card/Voucher, Treat as a POS Discount.
          • Handle Different Card/Voucher Types.
          • Reserve Gift Card/Voucher.

          * Indicates the functionality is already available in swiftpos releases prior to V10.64.

           

          How To?      ▲ ▼

           

          How To GET STARTED?      ▲ ▼

          Do as follows:

           

          How To Configure Back Office?      ▲ ▼

          Once the requirements have been met, then Back Office will need to be configured in order to support the Zen Global Gift Cards/Vouchers Interface. To do this, do as follows:

          • Zen Sales File - A ZEN file designation needs to be configured to ensure all Gift Card/Voucher Issues, Top Ups, Redemptions, etc are processed by Zen Global and attributed to the Gift Card/Voucher they are being applied to. To do this, do as follows:
            • Locate and select the Touch terminal, from which Zen Global Gift Card/Voucher functions are going to be performed, in the Touch POS Terminal screen.
            • Once selected, select the Tools option and then select the Options entry from the Tools menu to open the Settings screen.
            • In the Settings screen, select the Sales tab.
            • Add a ZEN entry to the File Extension/s field. An example of which can be seen below.

           

          • Zen Sales File continued ...
            • Select OK to save the change and exit the screen.
          • Media - Ensure the required Media that need to be attributed to the various Gift Card/Voucher Masks are created and appropriately configured. swiftpos Media are generally used for reporting purposes and also to be able to apply GST Exemptions. The Media configured would depend entirely on the Venue's reporting and GST exemption requirements. An example of Medias configured for Zen Global can be seen in the screenshot below.

           

           

          How To Configure NetPOS?      ▲ ▼

          Once the above requirements have been met, then the Zen Global settings will need to be configured. To do this access the Zen Global settings screen in NetPOS via the NetPOS Menu.

          Once the NetPOS Zen Global Settings screen is displayed, configure it as is appropriate.

           

          How To Configure Touch?      ▲ ▼

          Touch will need to be configured to ensure Zen Global Gift Cards can be issued, redeemed, etc, and Zen Global Accounts can be recharges/topped Up. To do this:



          Screens      ▲ ▼

           

          NetPOS Zen Global Settings Screen      ▲ ▼

           

          zen-global-2

           

          To access refer to How To Access The NetPOS Menu for more information. A NetPOS Registration for the Zen Global interface will be required in order to access this screen. Used to configure the settings required to implement the Zen Global Gift Cards/Vouchers interface.

           

          Tabs      ▲ ▼

           

          Settings Tab      ▲ ▼

          Header Section

          • Access Code - Default is blank. Displays/Enter the Access Code that must match the same Access Code configured at the swiftpos Touch terminal. This is not mandatory, but does provide an additional level of security.
          • Enquiry URL - Displays/Enter the URL provided by Zen Global.
          • Upload URL - Displays/Enter the URL provided by Zen Global.
          • Username/Password - Displays/Enter the credentials provided by Zen Global.
          • Serial Number - Displays/Enter the Serial Number provided by Zen Global.
          • Sale Type - Displays/Select from the drop down list one of the Sales Types. These are:
            • Sales - Summary
            • Department Breakdown
            • Full Item Breakdown
          • Account Name - Displays/Enter the Account Name provided by Zen Global.
          • Account Name - Displays/Enter the Account Name provided by Zen Global.
          • Locations - Displays/Enter the numbers of the Locations (separated by a comma) that are to be either Included or Excluded from being able to communicate with Zen Global. For example, enter Location number as 121,122,123.
          • Exclude/Include - Displays/Select from the drop down list whether the Locations entered are to be either Excluded or Included. The default option is Exclude.

           

          Notes ...


          By default, the Locations entered here will be considered as EXCLUDED Locations.

           

          • Get Offers - Select to ensure any offers are returned when a Customer's Frequent Shopper ID is entered/scanned at Touch. Refer to How To Get Offers for more information.
          • Apply Discount To Media - Select to enable and then enter the ID of the Media to which the Offer discount will be assigned. This can be helpful when it comes to reporting. Refer to the Sales Media reports.
          • System ID - Displays/Enter the System ID provided by Zen Global.
          • Company Code - Displays/Enter the Company Code provided by Zen Global.
          • Site Code - Displays/Enter the Site Code provided by Zen Global.
          • Departments - Displays/Enter the Codes provided by Zen Global for the following:
            • Voucher Sales
            • Voucher Redemption
            • Voucher Refund
            • Loyalty Redemption
            • Rounding
            • Discount
          • Surcharge PLU - Displays/Select the Surcharge PLU/Product that is to be assigned to the surcharge applicable, if any, is applied to the Gift Card/Voucher. Refer to How To Add A Surcharge PLU for more information.
          • Back Office Interface - Select from the drop down list the Back Office instance to connect with.

          Notes ...


          In general, this will only have one instance listed. However, multiple Back Office instances can be listed, in which case one needs to be selected.

           

          Grid Section      ▲ ▼ 

          Tabs

           

          Location Codes Tab      ▲ ▼ 

           

          Used to assign specific Serial Numbers, Company and Site Codes to individual swiftpos Locations. If no Location specific entry is added to the grid, then the Serial Numbers, Company and Site Codes assigned will default to the ones configured above.

          The grid displays:

          • Location - Displays/Enter the number of the swiftpos Location for which specific codes are required.
          • Serial Number - Displays/Enter the Serial Number to be assigned to the swiftpos Location.
          • Company Code - Displays/Enter the Company Code to be assigned to the swiftpos Location.
          • Site Code - Displays/Enter the Site Code to be assigned to the swiftpos Location.

           

          Location Group Codes Tab      ▲ ▼ 

           

           

          Used to assign specific Serial Numbers, Company and Site Codes to individual swiftpos Location Groups (Venues). If no Location Group (Venue) specific entry is added to the grid, then the Serial Numbers, Company and Site Codes assigned will default to the ones configured above.

          The grid displays:

          • Location Group - Displays/Enter the number of the swiftpos Location Group (Venue) for which specific codes are required.
          • Serial Number - Displays/Enter the Serial Number to be assigned to the swiftpos Location Group (Venue).
          • Company Code - Displays/Enter the Company Code to be assigned to the swiftpos Location Group (Venue).
          • Site Code - Displays/Enter the Site Code to be assigned to the swiftpos Location Group (Venue).

           

          Voucher Types Tab     ▲ ▼

           

          Used to create and configure the Gift Vouchers. This Tab is used by the legacy Zen Global interface and is valid for swiftpos release prior to v10.64.

          The grid displays a list of the Gift Card/Voucher Card Masks along with:

          • Voucher Type - To be continued ...
          • Name - To be continued ...
          • Can Redeem - To be continued ...
          • Can Topup- To be continued ...

           

          Voucher / Gift Card Masks Tab      ▲ ▼ 

           

          Used to create and configure the Gift Card/Voucher Card Masks for the current Zen Global Gift Cards/Vouchers interface and is valid for swiftpos release from v10.64 onwards. Card Masks are required to ensure Touch recognises Zen Global scanned Gift Cards/Vouchers, thus ensuring they are then processed as is appropriate.

          The grid displays a list of the Gift Card/Voucher Card Masks along with:

          • Name - Displays/Enter the name given to the Mask entry.
          • Type - Displays/Enter the type of Gift Card/Voucher Card Mask. The type entered here

           

          Notes ...



          It is IMPORTANT that the Type entered here is exactly as is provided by Zen Global. If entered incorrectly, Zen Global will not recognise it and hence will NOT process any requests associated with the incorrect Type. The screenshot above depicts that Types currently supported by Zen Global.

          • Card Prefix - Displays/Enter the prefix that identifies the Type of Gift Card/Voucher Card. For example, 601 is the prefix for all Gift Cards, and will be treated as such when entered/scanned at Touch.
          • Min/Max Length - Displays/Enter the minimum and maximum length in characters of the Gift Card/Voucher number.
          • Charge/Pay Media - Displays/Enter the ID of the swiftpos Media that is to be assigned to any transaction generated by Touch when the Gift Card/Voucher Card is either being used for charging (redemptions) and/or payments (top ups).

           

          Notes ...


          It is IMPORTANT that the Type entered here is exactly as is provided by Zen Global. If entered incorrectly, Zen Global will not recognise it and hence will NOT process any requests associated with the incorrect Type. The screenshot above depicts that Types currently supported by Zen Global.

           

            End of article      ▲