All Collections
Integrate
Eats365 POS
Eats365 POS Integration Quickstart
Eats365 POS Integration Quickstart

How to connect your PassKit account to your Eats365 POS account

Paul Tomes avatar
Written by Paul Tomes
Updated over a week ago

Best Practices

Prepare for Apple Certification before going live

To issue passes commercially, you'll need to upload an Apple Pass Certificate in your PassKit account. An Apple Developer account costs $99/year and can be obtained for individuals or businesses. Apple Certificate guide

Update member records from Eats365 platform

Eats365 is the primary source of data, and PassKit is responsible for rendering this data. You will need to update members' names, mobile numbers, points, credit, tiers, and other information on the Eats365 platform. Updating member information on PassKit will not be reflected in Eats365 POS.

9 Steps to Integrate PassKit with Eats365 POS

Step 1: Create program

  1. Navigate to Home and click on Create Project.

  2. Choose Loyalty + Eats365 to utilise the default Eats365 Loyalty Template for your pass design. What's Eats365 Loyalty Template?

  3. Click on Create

Step 2: Set design

  1. If you're not currently on the design page, simply go to the Program page and click on Design in the top menu. Next, click on the design icon for the Base tier.

  2. On the Design page, customise :

    For Google

    Logo image: An image displayed on the front's upper-left corner of Google Pass.

    Hero image: A full-width image displayed on the front of Google Pass

    For Apple

    Logo image: An image displayed on the front's upper-left corner of Apple Pass.

    Strip image: A full-width image displayed on the front of Apple Pass

Step 3: Set up Eats365 integration

  1. Navigate to the Program page.

  2. Select Settings on the top menu.

  3. Click on Integrations on the left menu.

  4. Select Eats365.

  5. In the Eats365 integration page, fill-in :

    Enable: Toggle on to enable the integration.

    Name: Name of this integration settings.

    Identifier: The organisation or group id provided by Eats365

  6. Click on Save

Step 4: Create tiers

The order in which you create tiers is important. Begin by creating a tier from a lower-tier option. For example, if you have Starter (first tier) and Pro (second tier), start from Starter.

  1. Navigate to the Program page.

  2. Select Design on the top menu.

  3. Click on Create New Tier in the tier table.

  4. In the Create a New Tier pop-up, fill-in:

    Select Base Tier: Choose a tier to copy pass design from.

    Eats365 Plans: Select an Eats365 member plan. If you do not see a dropdown list, you need to set up Eats365 integration first (Step 3).

    Tier Name: Automatically sets the Eats365 plan name.

    Tier ID: Automatically sets the Eats365 plan ID. The tier ID must have Eats365 plan ID to ensure proper integration.

    Use Eats365 Loyalty Design: Check the box if you want to overwrite the pass design with the Eats365 loyalty template.

  5. Click on Create

Step 5: Customise enrolment form

  1. Navigate to the Program page

  2. Turn on the Enrolment Allowed option for the entry tier

  3. Click on the Edit Icon in the tier row

Step 6: Customise welcome email

  1. Navigate to the Program page

  2. Click on Distribution on the top menu

  3. Click on Edit Welcome Email in the welcome email box

Step 7: Test your integration

User Action

Expected Outcome

Enrol a member from the enrol form of the entry tier.

  1. The member receives a welcome email containing a pass installation URL (if email is enabled).

  2. The pass barcode contains the Eats365 member ID.

Create a transaction with member points in Eats365 POS.

  1. The pass displays new points and transaction details.

Change the member's plan/tier in the Eats365 POS.

  1. The pass shows the new tier name.

  2. Pass design changes to the new tier's design.

Step 8: Publish Program

  1. Upload your Apple Pass Certificate to your account. Apple Certificate guide

  2. Navigate to the Program page.

  3. Select Overview on the top menu.

  4. In the Almost there box, fill-in:

    Project Name: Name of the live project

    Choose Apple Certificate to Use: Select your Apple Certificate

  5. Click on Launch Now

Step 9: Confiture Eats365 Integration on published program

Configure Eats365 integration for the published program following the same steps as in Step 3.

Pass Design

Each tier can have its own design. You can customise the design anytime. Navigate to your Program page, click on Designs in the top menu, and select the Design Icon in your tier column.

Eats365 Loyalty Template

The Eats365 Loyalty Template is a pass design customised to show Eats365 Points, Credit and Transaction History and an enrol form to correct HK mobile number. Simply select the Eats365 Loyalty Template at Create Project or Create Tier (Step 1).

These are the highlights of the Eats365 Loyalty Template.

  1. Points - Display Eats365 points.

  2. Credit - Display Eats365 credit balance.

  3. Barcode - Contains Eats365 member id.

  4. Latest Message - Shows announcements and promotions.

  5. Last Transaction - Display the details of the most recent transaction on Eats365, including the date, point opening balance, amount spent, and points earned.

Barcode

To customise the appearance and information associated with your barcodes :

  1. Navigate to Design page

  2. Select QR CODE

  3. In the Barcode box, customise:

    Barcode Type: PDF417 is recommended for Eats365 POS scanner.

    Encoded Barcode Content: Information stored within a barcode. To set the Eats365 member ID, click on the input field and select External ID from the dropdown menu, or manually type in ${members.member.externalId}.

    Text Below Barcode: Display human readable text.

  4. Click on Save

Fields On Pass

Credit Balance

Eats365 credit balance is mapped to the PassKit secondary points field.

Currency Symbol

  1. Navigate to the Program page

  2. Select Settings on top menu

  3. Click on Program Settings on left

  4. Scroll down to Points Setting

  5. Enable Secondary Points Type, then fill-in:

    Points Style: Select Currency

    Currency: Credit balance currency.

  6. Click on Save

Transaction Summary

The Transaction field displays the details of the last transaction, providing customers with information on the number of points earned.

If you are using the Eats365 Loyalty Template, you will find the Transaction field either on the pass itself or within the Items list. You can create the transaction field manually by following these steps.

  1. Navigate to Design page

  2. Drag and drop New Dynamic Field from Add custom field section

  3. In the Custom Field editor box on the right, fill-in:

    Field Name: Name of this custom field. Eg. Transaction.

    Field Type: Select Multi Line Text

    Label: Field label appears on the pass.

    Display Value:

    Date: ${meta.eats365.lastTransactionTime=-}
    Point Opening Balance: ${meta.eats365.lastTransactionOpeningBalance=-}
    Amount Spent: ${meta.eats365.lastTransactionCurrency=-}${meta.eats365.lastTransactionAmount=-}
    Point Earned: ${meta.eats365.lastTransactionPointsEarned=-}

    The dynamic values wrapped in ${} are case sensitive.

  4. Click on Save

Tiers

The tier determines the design of the pass. To ensure proper integration, the PassKit Tier ID must be set to the Eats365 Plan ID. If you have three Eats365 member plans, you'll need to create three PassKit tiers. The number of Eats365 member plans should match the number of PassKit tiers.

Enrolment Form

The Enrolment Form serves as the entry point for new members to join the loyalty program. Each tier has a unique enrolment form URL, so please ensure that you use the one corresponding to the correct tier.

Enrolment URL & QR Code

  1. Navigate to the Program page

  2. Select Distribution on the top menu

  3. Click on Share Icon in the tier row

Mobile Phone Default Country Flag

  1. Navigate to the Program page

  2. Select Distribution on the top menu

  3. Click the Edit Icon in the tier row

  4. Select the Mobile field on the enrol form

  5. In the edit box on the right, set the Default Value to the country code.

  6. Click on Save

Example

Default Value:

Appearance:

Terms & Conditions Field

If you are using the Eats365 Loyalty Template, follow the steps below.

  1. Navigate to Data Collection (Enrolment Form) Design page

  2. Click on Add Item

  3. Select Add present fields

  4. Drag and drop fields that say 'I have read and agree to the Terms and Conditions.'

To manually add a check box field, check this section.

Check Box Field

  1. Navigate to Data Collection (Enrolment Form) Design page

  2. Click on Add Item

  3. Click on Add custom field drop down

  4. Drag and drop a Checkbox onto the form

  5. In the edit box on the right, fill-in:

    Field Name: Name of the custom field.

    Required: Enable it if the field is mandatory.

    Label: Text associated with the checkbox

    Helper Text: Additional explanatory or instructional text

Required Field

To make a field mandatory, toggle the Required switch on. Mandatory fields are indicated with an asterisk (*).

  1. Navigate to Data Collection (Enrolment Form) Design page

  2. Select a field on the form

  3. In the edit box on the right, turn on Required

Links to Privacy Policy and Terms & Conditions

To include links to the Privacy Policy or Terms & Conditions in the enrolment form, just enclose the text in the following format: <a href='your_url'><u>Text</u></a>.

Example

Text:


Appearance:

Track Enrolment by Stores

You can change enrolment URL by stores to track number of customers enrolled to the loyalty program by stores or media.

  1. Add ?utm_source=source_name to the enrolment URL.

Example

You can create different enrolment links as shown below and monitor them on the Program page.

https://pub1.pskt.io/c/0igk4e?utm_source=Website for the website

https://pub1.pskt.io/c/0igk4e?utm_source=Central for the Central store

https://pub1.pskt.io/c/0igk4e?utm_source=Tsim%20Sha%20Tsui for the TST store (%20 represents a space)

You can also set other UTM parameters (e.g. utm_name, utm_term, utm_content, utm_medium). Those UTM information will be stored under each pass holder's record.

Welcome Email

The welcome email contains the pass URL and is automatically sent to a new member upon successful enrollment. If you don't receive the email, please ensure that the welcome email feature is enabled, and verify that the email address provided by the member is valid.

Enable or Disable Welcome Email

  1. Navigate to the Program page

  2. Select Distribution on the top menu

  3. In the welcome email box, toggle it on or off

Email Subject

  1. Navigate to the Program page

  2. Click on Distribution on the top menu

  3. Click on Edit Welcome Email in the welcome email box

  4. Edit Subject

  5. Click on Save

Example

Setting:

Appearance:

Email From (Sender's Name)

  1. Navigate to the Program page

  2. Click on Distribution on the top menu

  3. Click on Edit Welcome Email in the welcome email box

  4. Edit From (Sender's Name)

  5. Click on Save

Example

Setting:

Appearance:

Personalise the Message

To customise the email message, the following dynamic variables are available. The dynamic values are case sensitive.

Dynamic Field

Value

first name

${person.forename}

last name

${person.surname}

email

${person.emailAddress}

mobile number

${person.mobileNumber}

tier name

${members.tier.name}

Eats365 member ID

${members.member.externalId}

point balance

${members.member.points}

secondary points / credit balance

${members.member.secondaryPoints}

Example

Email Template:

Appearance:

Lock Screen Message

Lock screen message is a message shown on the lock screen of iOS devices. This notification feature is currently not available for Google Pay passes.

3 types of lock screen messages

Change Message

Sends a message when a value changes, for example, when the point value changes.

GPS Message

Displays a message when the pass holder is in a specific location, such as when they are near the store.

Beacon Message

Shows a message when the pass holder is near a beacon device.

Change Message

  1. Navigate the Design page

  2. Select an Apple Wallet tab

  3. Click on a field on the pass

  4. In the field editor box on the right, enter the Apple Lock Screen Message

Further details available on this guide.

Example

Display Value

Appearance

GPS Message

  1. Navigate to the Program page

  2. Select Designs on the top menu

  3. Click on Settings Icon in the tier row

  4. Click on Location (Apple Wallet) tab

  5. Click on Add Location

  6. In the Add Location box, fill-in:

    Name: Name of the location setting

    Address: The location that triggers a message

    Latitude

    Longitude

    Message: Lock Screen / notification message

Beacon Message

  1. Navigate to the Program page

  2. Select Designs on the top menu

  3. Click on Settings Icon in the tier row

  4. Click on Beacons (Apple Wallet) tab

  5. Click on Add Beacon

  6. In the Add Location box, fill-in:

    Name: Name of the beacon setting

    UUID: The identifier of a beacon device

    Major: A numeric value that is used to group related beacons together

    Minor: A numeric value that is used to further distinguish individual beacons within the same major group

    Message: Lock Screen / notification message

Member Management

Get Pass URL

  1. Navigate to the Program page

  2. Select Members on the top menu

  3. Click on the Other Action dropdown in the member row

  4. Click on Pass URL

Resend Welcome Email

  1. Navigate to the Program page

  2. Select Members on the top menu

  3. Click on Edit Member in the member row

  4. In the profile box, click on Resent Welcome Email

Export CSV

  1. Navigate to the Program page

  2. Select Members on the top menu

  3. In the Members box, click on Export CSV

Troubleshooting

Problem

Solution

The point balance/credit is not correctly shown on the pass.

All Devices:

Make sure the device is connected to the internet.

For iPhone:

Ensure that Automatic Update is enabled for the pass by navigating to Wallet, selecting the pass, and accessing the Notifications option from the menu (located as three dots icon on the top right).

Payment Type:

Ensure that the customer is paid through payments entitled for earning points.

Customer did not receive a lock screen notification.

For iPhone:

Ensure Allow Notification is enabled for the pass by navigating to Wallet, selecting the pass, and accessing the Notifications option from the menu (located as three dots icon on the top right).

For Android:

Google Wallet does not deliver lock screen notifications.

Pass Design Settings:

Make sure the Apple Lock Screen Message is configured on the pass design as described in this guide.

Archive

Did this answer your question?