1-Way Lightspeed Integration
Last Update 9/18/24
Overview
Yellow Dog’s 1-way integration with Lightspeed pulls sales transaction detail from Lightspeed’s API.
This integration supports clients running Lightspeed’s L Series.
Sync Approach
The integration contains one element:
SyncWithMicrosServices
The SyncWithMicrosServices applications pulls sales transactions from Lightspeed’s API.
The sync can be installed from any location that can access the Lightspeed’s API. Typically this will be installed on the Yellow Dog server.
Sync Frequency
The Yellow Dog Inventory sync can be run at any customized frequency. By default this will be set up to run hourly.
Configuration
This sync supports mulitiple revenue centers per Yellow Dog.
Requirements
Client
The Client is responsible for providing a login with access to Lightspeed’s API.
This login will provide Yellow Dog the following detail:
API Ids
Location Ids
RVC Codes
The Client will need to work with Yellow Dog to ensure the correct RVC Codes and Location IDs are mapped to stores in Yellow Dog.
The client will also need confirm the Recipet Status, Reciept Types and Transactions Price Types that should be pulled into Yellow Dog.
Yellow Dog
Yellow Dog will connect to Lightspeed’s API using provided credientials.
Responsiblities
Yellow Dog
Yellow Dog is responsible for configuring and scheduling the SyncWithMicrosServices.
Data Exchange and Mapping
Sales Data
Our Sync pulls in the following transaction data:
| Lightspeed Field | Yellow Dog Field |
|---|---|
| Receipt.id | TranscationNumber |
| Item.id | TranscationLineNumber |
| receipt.modificationDate | CheckClosed |
| item.prodId | Item Number |
| item.productPLU | SKU |
| item.productName | Item Description |
| item.unitPriceWithoutVat | Item Retail |
| item.discountPriceWithoutVat | Item Discount |
| itemDiscountName + checkDiscountNames | Discount Description |
| item.amount | Quantity |
| receipt.userId | Employee Number |
| payments | Tender |
| Reference - if check status= void, then VOID, if check status = voided, then VOIDED; if check status= void and return to stock is true, then RETURN [original transactionnumber] | |
| itemTax | Tax Value |
| payment.amount | Tender Value |
Additional Information
Limitations
When checks are deleted in Lightspeed the ticket is no longer in the API
If an entire check is voided, the voided tax is not provided in Lightspeeds’s API
We support voids, both returned to stock and not returned to stock, but we do not support Deleted tickets (3/20/2023)
Multiple instances is currently not supported
Discounts are spread across items on the check which sometimes does not assign to the items as expected based on the check, however discount total does match
Lightspeed’s K Series is not supported by this integration
·
