Tapin2 1-Way Integration
Last Updated 10/16/2024
Overview
Yellow Dog's 1-Way integration with Tapin2 pulls sales, locations, and products from Tapin2’s API.
Sync Approach
This integration involves two elements:
Yellow Dog’s Tapin 2 Console application to pull sales from Tapin2’s API
Process Sales Data application that processes sales to deplete inventory and update reporting
Sync Frequency
This integration supports a manual queue that will allow for sales to be processed manually on demand by the client or can be scheduled to hourly with additional scheduling options upon request.
Configuration
This integration supports
multiple instances of Tapin2 to a single Yellow Dog database.
multiple locations (revenue centers) to a single Yellow Dog Store.
This integration also can pull historical data, but Tapin2 must provide Yellow Dog with transactionHours to back pull. Without this setting, the sync will pull any order that have been added or updated in the Tapin2 API since the last sync.
Requirements
Client
The client will be responsible for:
Mapping Tapin2 Locations to the corresponding stores in Yellow Dog
Some configurations may require the client to map recipes to menu items sold to deplete inventory. Please confirm with your Implementation Guide on the approach.
POS Partner
Tapin2 will need to provide:
Tapin2 API authKey
Tapin2 VenueID as it relates to stores in Yellow Dog.
Yellow Dog
Yellow Dog is responsible for configuring the Tapin2 Console and Process Sales application.
This integration requires Yellow Dog Inventory version 375+.
Data Exchange
Sales Pull
We pull the following data from Tapin2’s API to populate our TPTransactions:
| Sales - TPTransaction | Tapin2 API |
|---|---|
| ThirdPartyID | Tapin2_{config.venueId}_{order.locationId}_{order.id} |
| Converted | {transaction.ThirdPartyID}_{item.id} |
| Revenue Center | order.locationId |
| TransactionNumber | order.id |
| SalesChannel | (ApplicationService) order.service.Value |
| CheckClosed | Helpers.GetEffectiveCheckClosed(order.orderDate, order.saleDate, order.venue.timeZoneInfo.Id) |
| ItemNumber | item.product.id |
| SKU | item.product.upc |
| Item | item.product.title |
| ItemRetail | item.pricePer |
| ItemDiscount | (Math.Abs(item.discount.Value) / (hasQty ? Math.Abs(item.quantity.Value) : 1)) * -1 |
| DiscountDescription | item.discountCode |
| Quantity | item.quantity |
| Tender | (in tptransactiondetail only) |
| Reference | if (transaction.Quantity < 0) transaction.Reference += $"VOID" |
| RegisterNumber | order.deviceId |
| ParentNumber | converted of item modified |
| Detail - tax | order.taxaddedNet or order.taxincludedNet |
| Detail - tender | order.payments |
Sales will be mapped via the POS Item Map in Yellow Dog or matched via SKU/UPC
To match sales, the client will need to have our SKU entered into the External Ref Id field on the item in Tapin2 for sales to assign to the item in Yellow Dog
Tapin has a download/upload tool on their admin portal products page where the SKU/UPC can be copied to the External Ref Id
Additional Information
Voids will appear in Yellow Dog as one positive quantity line for them item, followed by one negative quantity line for the same item, equaling out to a 0 quantity.
Yellow Dog can now support pre orders within Tapin2. Orders will not be processed until the Tapin2 event end date. (5/15/24)
Limitations
There is no Employee data available to us in transactions (3/3/2023)
We have not tested any data with returns, discounts, or priced modifiers (3/3/2023)
