Lightspeed integration manual

This manual will talk you through the process of linking your Lightspeed shop to the Trunkrs Shipping portal. Please follow the steps below for a seamless integration.

Requirements

The connection requires three accounts:

• Lightspeed account, accessible via the Lightspeed API Key

• Trunkrs customer account, accessible via a client id and client secret

• Trunkrs shipping portal account

The first two accounts are created for you and you will only have to obtain the credentials (see instructions below). The last account you can create yourself, we will guide you through it all in this manual.

1. Obtaining a Lightspeed API Key

In order for us to manipulate the front-end of your store (show a Shipping option on selected times) and to pull in the shipments where Trunkrs was selected as Shipping provider, we need to gain access to your store. This is done via an API Key. Unfortunately Lightspeed does not offer an automated way to do this, so if you did not request a key before you will have to do this by writing to the customer service: https://ecom-support.lightspeedhq.com/hc/nl/articles/220320568-API-documentatie

2. Obtaining a Trunkrs API credentials

Once we are able to talk to Lightspeed through the Lightspeed API key, we also need to be able to talk our API. To connect your Shipping Portal account to our main system we ask for a:

• Client ID,

• and Client Secret

If you are a new customer, these will be sent to you by our Sales team once our IT has created the account. If you are an existing customer you can request this information by sending an email to tech.support@trunkrs.nl.

3. Creating a shipping portal account

Creating a Shipping Portal account is super easy and can be done by you yourself. Please follow these steps:

1. Visit https://lightspeed.trunkrs.app/client/register

2. Fill in the form and register for an account

3. You can now login!

4. Configuring the Shipment Method

1. After login in you will see Your Shipments page wherein you will find and manage all Trunkrs Shipments.

2. Let’s hit the Plugin configurations in the menu for the: shipping method configuration

3. You will see Configure Plugin button for the first time, this means the plugin is not yet configured and it needs to be configured.

4. Start with completing your account details. These will be used as the sender information in our system.

5. Now let’s continue to the actual configuration:

   1. under enable select yes to enable the plugin

   2. under title enter the title of the shipment method (this is visible to your customer). We would suggest something like Trunkrs or Trunkrs Same Day Delivery

   3. under description you can give a super short description of the shipment method (also visible to the customer). We would suggest Super snelle bezorging met Trunkrs

   4. under price 1st shift enter the price (in euro’s) you want to charge to your customer for selecting Trunkrs during the first-shift time span (check the blue information box below for clarification)

   5. under timespan 1st shift select the time span for the first shift. This is the time the shipment option will be shown in your front-end for the price of the 1st shift.

   6. under price 2nd shift enter the price (in euro’s) you want to charge to your customers for the second trunkrs shift (often next day delivery)

   7. under timespan 2nd shift select the timespan. If you do not want to offer a second shift drag both handles all the way to the left. It should show 12:00AM - 0:00AM

   8. The plugin will automatically be enabled in the weekends (delivery will be on monday). Under price weekend you can enter the price (in euro’s) you want to charge your customer.

6. Finally let’s setup the connection with Trunkrs:

   1. under client id (staging) enter the staging client id you have received from Trunkrs

   2. under client secret (staging) enter the staging client secret you have received from Trunkrs

   3. under client id (production) enter the production client id you have received from Trunkrs

   4. under client secret (production) enter the production client secret you have received from Trunkrs

   5. set the API mode toggle to the left for staging (test mode) to create test shipments for which you will not be charged, or to the right for live mode to actually start shipping.

   6. finally let’s hit the blue button Test staging/live API Connection after loading it should show: connected! If this does not happen, please check the credentials.

   7. Let’s now hit the save button to return to the configuration steps overview

5. Configuring the Lightspeed connection

1. After configuring the Shipment Method, you can configure the Lightspeed API configuration hit the button configure

2. Let’s configure lightspeed:

   1. under Lightspeed API key enter the api key provided by Lightspeed (see step 1 of this manual)

   2. under Lightspeed API secret enter the api secret provided by Lightspeed

   3. under store language select dutch or english

   4. under cluster select the cluster you are in. This should be webshopapp if you are a dutch webshop (https://ecom-support.lightspeedhq.com/hc/en-us/articles/115000272353-2-b-Cluster-information)

   5. hit save api credentials to return to the overview

6. Connecting / Disconnecting the Shipping Portal

The final step of configuration is connecting the shipping portal to Lightspeed. This will setup the actual shipping method. Under Lightspeed API configuration, you will see two buttons, which is the Connect and Disconnect, hit the button connect to connect the plugin to the Lightspeed checkout or hit the button disconnect to disconnect the plugin. If all goes well it will show a status: Connected if not, please check the lightspeed credentials.