Lightspeed K-Series

Introduction

The following section will provide a walkthrough of different steps to connect your Lightspeed KS series with UrbanPiper.

Authorization

In all Lightspeed K-Series onboarding flows, authorization is the first step. This enables UrbanPiper to establish a connection with the Lightspeed K-Series POS. This can be accomplished through the UrbanPiper Atlas Portal by navigating to— Settings → POS Integrations → Checking the Tick Box → Authorize.

(if you do not see the option, it could be due to the fact that your POS integration is not enabled. Connect to the customer service team to get this set up for your account) This will direct the client to the Lightspeed login page.

The Lightspeed Login Page will require the user to use their Lightspeed POS backoffice Username and Password. Once logged in, the screen will display 3 options, and the Client will need to enable all 3.

Once this is completed, the Client will be authorized and will see the following screen on UrbanPiper Atlas.

NOTE: The Order and Menu Configs will need to be processed by the UrbanPiper CSM Team.

Configs On Lightspeed K-Series POS

This is a multi-step task that requires processing on the Lightspeed K-Series POS Backoffice by the Client or by the UrbanPiper Team with Approval from the Client.

Create UrbanPiper Accounting Group

The Client/CSM is required to create a new Accounting Group on the Lightspeed K-Series POS Backoffice.

Login to Lightspeed K-Series: Back Office → Menu Management → Accounting groups → Add an Accounting group

Fill in the following values for the fields— Accounting group name: UrbanPiper (For ease of Identification) Accounting ID: “Leave Undefined” Tax profile: No Tax (as this is a non-taxable field)

This configuration allows the characterisation of the items that will be created by the Client to manage the Integration.

Create Charge and Discount Items

The specific charges received from the Aggregators will be relayed to the POS with the above tags. if the Client requires Aggregator-specific charges, the same needs to be created Aggregator-specific on the POS Backoffice.

Menu Management in Lightspeed K-Series Back Office → Items → Create → Single Item

The following charge items must be created in POS Backoffice and assigned to the previously created Accounting Group named "UrbanPiper":

• Service Charge

• Delivery Charge

• Packaging Charge

• Surcharge

Additionally, the following discount items should also be created:

• Uber Eats Discount

• Deliveroo Discount

• Just Eat Discount

Important Configuration Details:

All items listed above must:

• Be added to the UrbanPiper Accounting Group

• Have their price type set to "Manually-entered price"

• Share SKU codes for each of the above create Items with the UrbanPiper CSM team (to be updated in the Atlas Portal)

Create Payment Methods

To support handling third-party/ Aggregator platform transactions, the following custom Payment Methods need to be created in the Lightspeed K-Series POS Backoffice

Lightspeed K-Series POS Backoffice Configuration → Settings → Payment Methods → Add Payment Methods

Payment Methods to Create:

• ubereats-cash

• ubereats-online

• deliveroo-cash

• deliveroo-online

• justeat-cash

• justeat-online

Fields:

• Payment method type: Other Payment Methods

• Code: “the above mentioned” (Please note the code is case sensitive, please copy and paste the above mentioned as the codes)

• Name: Can be the same as code

• Accounting Reference: can be left blank

• Allow Tipping: “True”

This data, using the same codes shared above, will be backfilled intothe Atlas Portal.

Create Order profiles (Optional)

The client will need to create Order profiles in the Lightspeed K-Series POS Backoffice if they require the orders to be segregated based on the Aggregators - *Recommended*

Lightspeed K-Series POS Backoffice Configurations > Settings > Order profiles > Add Order profiles

Order Profiles to be created:

• ubereats-menu

• justeat-menu

• deliveroo-menu

Fields:

• Name: same as code

• Code: “mentioned above”

• Play sound when receiving online order: “True”

• Takeaway mode: Pick Up

• Order completion: “Complete when ready for Delivery”

• Production deadline: “Disabled”

• Show delivery code on receipt: “True”

• Print a draft receipt when the order is created: “True”

Other Optional Configs

Fields:

• Lightspeed POS - Timezone: Select based on location

• Lightspeed POS - Tax Exclusive: Config for NOAM

• Lightspeed POS - Is region North America or not: Config for NOAM

• Lightspeed POS - Food prep time (in minutes): Set-up to establish the delay in relay of Future orders (only) to POS.

• Lightspeed POS - Food prep plus delivery time (in minutes): Set-up to establish the delay in relay of Future orders (only) to POS

• Lightspeed POS - Enable Order Failure Workflow: to track order ingestion on POS and to trigger Push to POS in case of failure via the Prime app

• Lightspeed POS - Enable Order Failure Notification: triggers notification to Lightspeed POS for order failure and reason for failure.

Configs On UrbanPiper Atlas Portal

Once above mentioned Accounting Group, items, payment types and Order Profiles are created in the Lightspeed K-Series POS Backoffice you can would need to update some details on the Atlas portal to ensure that the integration with Lightspeed works as expected.

Create your Locations

The locations can be created on the UrbanPiper Atlas Portal to match the locations on the POS end.

The Locations can be created as following: Navigate to Locations Tab → Add Location → Select Single or More than One → fill in required Details → Save

Once the location is created, the Lightspeed POS Location ID needs to be added into the POS ID field. The Lightspeed Location ID can either be sourced from the Liughtspeed HomePage URL or Via Postman - (Automation for this process is under development)

Setting up Order Relay

These are the configurations to be done on the UrbanPiper Atlas Portal specifically for order relay to Lightspeed K-Series POS.

This step is again divided into multiple steps.

Lightspeed POS - Account Profile

This field directly corresponds to the Order profiles on Lightspeed K-Series POS. Here, the user will need to input the previously created Order profiles on Atlas, associating them with the correct Aggregator.

The same structure needs to be followed for all relevant aggregators.

Lightspeed POS - Charge ID

This field directly corresponds to the Charge Items created on Lightspeed K-Series POS. Here, the user will need to input the previously created Charge Item SKUs on Atla, associating them with the correct Aggregator and Charge Name. (Please note that this is case sensitive.)

The string values are the Charge Item SKU on Lightspeed K-Series POS Backoffice.

Lightspeed POS - Discount ID

This field directly corresponds to the Discount Items created on Lightspeed K-Series POS. Here, the user will need to input the previously created Discount Item SKUs on Atlas, associating them with the correct Aggregator. (Please note that this is case sensitive.)

The string values are the Discount Item SKU on the Lightspeed K-Series POS Backoffice.

This field directly corresponds to the Payment Methods created on Lightspeed K-Series POS. Here, the user will need to input the previously created Payment Methods on Atlas, associating them to the correct Aggregator and type ie. Cash and Online. (Please note that this is case sensitive).

Menu Configuration

Fields:

• Lightspeed POS Menu - Domain value: Menu Name on Lightspeed POS

• Lightspeed POS Menu - ikentooMenuId: Menu ID on Lightspeed POS (Can be sourced via the Menu URL or Postman)

• Lightspeed POS Menu - Merchant Biz Ref ID: Lightspeed POS Biz ID (Can be sourced via the HomePage URL or Postman)

• Lightspeed POS Menu - Accounting Groups to skip: Accounting Group ID - Use UrbanPiper Accounting Group (Can be sourced via the Accounting Group URL or Postman)

• Pull Specific Menu: If enabled, pulls only the Specified Menu using Group Names and Categories

• Use Lightspeed Internal Names: If enabled, Orderides Lightspeed Internal Names to Item Name on UrbanPiper.

Please note: Automation for this process is under development