Zippin - NOTE, NOT PRODUCTION YET, SPECS NOT FINALIZED - The below is not certified yet.
Last updated: 9/10/24
Overview
Our Zippin integration is a 1-Way integration in which Zippin posts sales data via webhook for Yellow Dog Inventory to process.
Sync Approach
This interface contains three elements:
Zippin’s process to post sales to Yellow Dog’s ShowDog API via a webhook URL that Yellow Dog provides.
Yellow Dog’s ZippinApiConsole application to pull those sales from an Amazon S3 bucket into the Yellow Dog database, match transaction lines to YD items, and adjust on hands.
Yellow Dog’s ProcessSales application, which updates calculated costs and sales report data for the adjusted items.
Sync Frequency
By default the ZippinApiConsole is scheduled to run hourly and the ProcessSales application is scheduled to run daily.
Additional scheduling options are available upon request.
Configuration
Multiple Zippin Locations can be mapped to a single Yellow Dog Store.
Multiple instances of Zippin to a single Yellow Dog database is not supported.
Requirements
Zippin
Zippin will need to provide Yellow Dog with the apiKey for the site.
This is used to pull Location and Item data from Zippin’s API so that they can be mapped to Yellow Dog stores and items.
Configure their process to post transactions for the site after Yellow Dog provides the site-specific URL.
Client
Client will need to confirm Location mapping (Zippin store to YD store)
Client will need to confirm the method they will use to match sales to YD items.
Options are: POS Item Map, SKU Match, SKU and/or UPC Match, Item Match via Balto.
Yellow Dog
Yellow Dog will create a unique site id that will be used to generate the webhook URL for the site.
Yellow Dog will provide the webhook URL to Zippin.
We recommend that Yellow Dog is hosted by us, otherwise additional steps will be required to set up Non-Hosted API access.
Data Exchange
Sales Data
We pull in the following sales data:
| Zippin Field | Yellow Dog Field |
|---|---|
| StoreId | Revenue Center |
| CartId | TransactionNumber |
| entryTimestamp | CheckClosed |
| item.Sku | ItemNumber |
| item.Sku | SKU |
| item.Name | Item |
| item.UnitPrice | ItemRetail |
| item.DiscountsApplied | ItemDiscount |
| item.Quantity | Quantity |
| Status | Order Status |
| CartId | Order Number |
Code Data
We also pull in the following from Zippin’s API for Location and Item mapping:
For Locations:
storeId
For Items:
item.Id
item.Name
Workflows - Where Performed
| Workflow | Yellow Dog Inventory | Zippin |
|---|---|---|
| Create Retail POS Items | Done in both Yellow Dog and Zippin | Done in both Yellow Dog and Zippin |
| Create Stadium Stand POS Items | Done in both Yellow Dog and Zippin | Done in both Yellow Dog and Zippin |
| Create Restaurant POS Items | Done in both Yellow Dog and Zippin | Done in both Yellow Dog and Zippin |
| Modifer Creation | Done Only in Zippin | |
| Modifer Assignment to Items | Done Only in Zippin | |
| Screen Placement for Items | Done Only in Zippin | |
| Discount Setup | Done Only in Zippin | |
| Discount Assignment | Done Only in Zippin | |
| Tax Setup | Done Only in Zippin | |
| Tax Assignment | Done Only in Zippin |
Actions in Yellow Dog Inventory - Result in Zippin
| Yellow Dog Inventory Action | Zippin Result |
|---|---|
| Item Edited In Anyway and Saved | none - this integration is pulling sales data only |
| Item Inactivated | none - this integration is pulling sales data only |
| Item Removed | none - this integration is pulling sales data only |
| Level Is Changed | none - this integration is pulling sales data only |
| Item has POSDescription 1, Publish set to "Yes" and POS Available set to "True" | none - this integration is pulling sales data only |
| Publish set to "No" | none - this integration is pulling sales data only |
| POS available set to "False" | none - this integration is pulling sales data only |
| Uncheck Availability to One Store; Item still available to other Stores | no result in POS, but could result in transaction data not matching to items properly; if the item isn't available to the store the transactions is associated with, the item will NOT match to the sale in YD. |
| Uncheck Availbility for All Stores | no result in POS, but could result in transaction data not matching to items properly; if the item isn't available to the store the transactions is associated with, the item will NOT match to the sale in YD. |
| Image added to Item in YD | none - this integration is pulling sales data only |
| Image removed to Item in YD | none - this integration is pulling sales data only |
| On Hand changed in Yellow Dog | none - this integration is pulling sales data only |
Actions in Zippin - Result in Yellow Dog Inventory
| Zippin Action | Yellow Dog Inventory Result |
|---|---|
| Item Returned | n/a - not currently supported |
| User Created Item in Zippin, not in YD | none, unless item is sold, then it will likely not be matched to an item in YD |
| Change Item Detail in Zippin, not in YD | Overwrite items in Zippin the next time YD makes a change to the item in our system |
| Item is sold in Zippin that is removed in YD | If the POS Item matches to the YD item, the YD item will be adjusted based on the sale, and will be unremoved automatically because the on hand of the item will no longer be 0 |
| Item sold in Zippin that is Inactive in YD | If the POS Item matches to the YD item, the YD item will be adjusted based on the sale |
| Menu Item Sold at POS | Populates in YD POS Item Mapping |
| Menu Item Created at POS | Populates in YD POS Item Mapping |
| Modifier Sold at POS | n/a |
| Modifier Created at POS | n/a |
| Image added to Item in Zippin Only | None |
Additional Information
Limitations
This integration does not support tax and tender for accounting exports. (8/28/24)
This integration does not support modifiers. (8/28/24)
This integration does not currently support returns. (8/28/24)
Because this is a webhook integration, historical sales (transactions completed prior to Zippin setting up the process to post to the webhook URL) are not available. (8/28/24)
There is an option to pull historical sales via Zippin’s API, but that is not recommended.
