Squirrel 2-Way Integration Via API
Last Updated 4/3/2023
Overview
The integration with Squirrel allows for a 2-Way Retail integration where Squirrel pulls new item and updates from Yellow Dog and then posts sales data using our API.
For Food and Beverage clients please refer to the Squirrel 1-Way Integration.
Sync Approach
This interface contains three elements:
Squirrels’ “sqYellowDogService” that controls the pushing of sales and pulling of items
Yellow Dog’s process sales application that process transactions posted by Squirrel to deplete inventory and update reporting in Yellow Dog.
Sync Frequency
Squirre’s sqYellowDogService runs after the 10 minute of every hour and Yellow Dog’s process sales application will run hourly.
Configuration
If there are pre-existing items in Squirrel, your Implementation Guide can assist with matching the item however we recommend pushing in items as new as the cleanest approach.
Requirements
Client
The client will need to assist the Implementation Guide in assigning the Tax Group and Categories to the correct items in Yellow Dog before Squirrel pulls items.
The Tax Group and Categories are configured in the Interfaces section of Yellow Dog.
POS Partner
The integration requires Squirrel version 11.20 or higher.
Squirrel is responsible for
posting Tax Group and Categories to Yellow Dog’s API
configured and scheduled the sqYellowDogService
turning on their procedure to pull items after configuration is done
Yellow Dog
Yellow Dog will need to provide the following to Squirrel:
ClientID
StoreID
Yellow Dog Username and Password
Yellow Dog will need to configure and schedule the Process Sales application and notify Squirrel when Item Configuration is done.
Data Exchange
Item Data
The following Item Data is pulled from Yellow Dog.
| Squirrel Field | Yellow Dog Field |
|---|---|
| Menu Entry Name | Description |
| Bar Code (UPC) | SKU |
| PLU | SKU |
| Price List | Retail |
| UPC Manager | UPC |
Sales Data
The following sales data is received by Yellow Dog.
| Squirrel Field | Yellow Dog Field |
|---|---|
| Check Number | Transaction Number |
| Check Line | Transaction Line Number |
| Close Time | Check Closed |
| Item Number | Item Number |
| Bar Code (UPC 1) | SKU |
| Menu Entry Name | Item Description |
| Item Listed Price (Before Discount) | Item Discount |
| Promo/Discount | Discount Description |
| Factor | Quantity |
| Payment Name | Tender |
| Employee Number | Employee Number |
| FirstName LastName | Employee Name |
| Employee Number | Register Number |
| FirstName LastName | Register Number |
| ItemId on Check | Converted |
Additional Information
Limitations
Any items sold at the POS but those items are not in Yellow Dog must have a PLU assigned in order for that sale to come into Yellow Dog
Squirrel has a SKU length limit of 18 numeric characters
When an item is marked as Inactive and Removed in Yellow Dog, the status and settings of the item are not affected in Squirrel.
Squirrel can support up to 50 UPCs for an item
Returns and Voids are not included in the transaction data provided by Squirrel.
The following is not currently supported by Squirrel:
On Hand Push
Calculated Cost
Vendor Price
Images
Additional Notes
The Squirrel PLU automatically drops the first SKU digit but it does not impact the ability to scan the item and no changes to the UPC entered into Yellow Dog are needed.
