1-Way Harbortouch Integration
Last Updated 9/3/2021
Overview
The integration with Harbortouch POS is a 1-Way interface where Yellow Dog Inventory pulls sales data and reduces inventory levels based on transactions from Shift4’s API using SyncYdiWithMicrosServices.
Sync Approach
This integration contains one element:
SyncWithMicrosServices
Yellow Dog Inventory uses a SyncWithMicrosServices application to pulls sales data from Shift4’s API.
Sync Frequency
The sync by default will be scheduled to run hourly.
Requirements
Client
The client will need to perform the installation request for Yellow Dog on Shift4’s marketplace. Once this is complete Yellow Dog will be provided needed API permissions, Client Secret and Location IDs.
A location ID should be created in Harbortouch for every Yellow Dog Store that you want to map sales to.
Yellow Dog
This sync requires Yellow Dog v362 or higher.
Responsibilities
Client
The client is responsible for mapping items and recipes to Menu Items sold from Harbortouch using POS Item Map to deplete inventory.
Yellow Dog
The Yellow Dog Implementation Guide will be responsible for setting up the API configuration and scheduling the SyncYDIwithMicroServices application.
Data Exchange and Mapping
Sales Data
We pull in the following data from Harbortouch:
| Harbortouch Field | Yellow Dog Field |
|---|---|
| ticket orderNumber | TransactionNumber |
| Generated by YD | TransactionLineNumber |
| ticket closedAt | CheckClosed |
| ticketitem itemRef | Item Number |
| ticketItem itemRef | SKU |
| ticketItem Name | Item Description |
| ticketItem unitPrice | Item Retail |
| ticketItem ticketItemDiscounts discount amount | Item Discount |
| ticketItem ticketItemDiscounts discount name | Discount Descripiton |
| ticketItemQuantity | Quantity Sold |
| ticket closedByEmployeeRef | Employee Number |
| ticket closedByEmployee | Employee Name |
| microservice_Shift4 | Source |
| Tender | Tender (comma separated list when multiple) |
| When a modifier line, this field is populated with the Converted of the item | Parent Number |
| Shift4_[RVC]_[TransactionNumber] | Third Party ID |
| always 0x0 | Item Id |
| Shift4_[RVC]_[TransactionNumber]_[ItemNumber]; if a modifier, append parent item's converted with _Modifier[ItemNumber] | Converted |
If Transaction Detail is enabled in the API sync configuration in Yellow Dog, the sync will also pull in Tax and Tender data when available.
Additional Information
This integration supports the ability to map Unsold Menu items using the “Insert Unsold Menu Items” button in POS Item Mapping.
Limitations
Shift4’s API does not include Returns or Voids so they are not supported in this integration.
Tax type is not provided so taxes will all be named “Default”
