Summary

This document describes the guidelines for integrating with the Sparkfly POSitouch integration.

Intended Audience

This document is useful for developing additional POSitouch integrations or software that will integrate with our POSitouch agent. For instance, if you are an online ordering provider and wish to apply loyalty or coupon credentials to the check in POSitouch, and have the Sparkfly extension treat it as a credential of our own.

Adding a Credential to the Check

The Sparkfly extension uses a menu entry item to track applied credentials. A credential can represent a coupon code, a loyalty member or any other piece of identifying information tied to an offer, a loyalty account or individual. In order to create credentials on the check, the integrator must create a menu entry using the same ScreenCell or ItemNumber that is configured in the Sparkfly extension. The menu entry is configured as a $0 item in POSitouch. A memo menu item must also be configured.

To create a credential on the check, you are most likely using the POSitouch Order XML Interface. An example of a Sparkfly credential would be:

    <ItemDetail>
        <ItemNumber>100</ItemNumber>
        <Quantity>1</Quantity>
    </ItemDetail>
    <ItemDetail>
        <ItemNumber>101</ItemNumber>
        <Quantity>1</Quantity>
        <Memo>123456789</Memo>
    </ItemDetail>
    <ItemDetail>
        <ItemNumber>101</ItemNumber>
        <Quantity>1</Quantity>
        <Memo>Bob Loblaw</Memo>
    </ItemDetail>

Note the following from this this XML:

• The credential being applied is 123456789.
• The credential parent menu item is ItemNumber 100.
• The credential memo item is ItemNumber 101.
• The parent item preceeds the child memo.
• The first child item is the credential. You may supply additional memos, and our integration will ignore them, but our credential identifier (123456789) must be the first memo. In the example, the guest's name (Bob Loblaw) is in the second memo slot.
• In this example we are using the ItemNumber approach to ordering items within POSi. Using ScreenCell is also supported. The key concept here is that whatever ItemNumber or ScreenCell you are using here should match the Sparkfly configuration.

The Order XML Interface is a POSitouch API. For details of its operation, please contact POSitouch.

There are important caveats with this system:

1. The Sparkfly extension will not immediately apply offers to this credential. This will happen once the user opens the table, and either SEND ORDERs, or PRINT CHECKs.
2. The Sparkfly extension may remove the credential you create, if, in the process of querying the platform, the credential is returned as invalid from the server.
3. The presence of this credential will result in a FINALIZE occurring for this transaction.

Troubleshooting

Please contact your Sparkfly account representative if you need assistance, or e-mail support@sparkfly.com.