Jonas API 2-Way Retail Integration
Last Updated 9/10/2024
Overview
The integration with Jonas’s allows for a 2-way Retail integration to the Yellow Dog Inventory system using Yellow Dog’s API.
For Food and Beverage clients please refer to the Jonas 1-Way integration page using the file exchange approach located here.
Sync Approach
The 2-way integration via Yellow Dog’s API allows Jonas to control the push of sales and pull of item data to and from Yellow Dog Inventory.
Yellow Dog will have a Process Sales application that will run to process the transactions posted to the API for reporting and to deplete inventory accordingly. This application needs to be run after End of Day completes and will be configured to run nightly, on the hour between two and six am.
Sync Frequency
The frequency of the sync is controlled by Jonas. We recommend setting this to hourly to pull in new or updated item information.
Sales transactions in Jonas are only provided and processed once per day (after the user initiates the End of Day process in Jonas).
Configuration
Jonas version 2024.0009 is required in order to use this approach.
Requirements
Client
The client needs to be on Jonas version 2024.0009.
POS Partner
Please contact Jonas for details on their implementation process, fees, requirements, and lead time.
We understand the list price for this interface is $500 with a $150 annual support fee.
Yellow Dog
The Yellow Dog Client must be hosted by Yellow Dog to utilize Yellow Dog’s API.
From Jonas, Yellow Dog will need:
Client Code
Club Code
Partition Code
Area Code(s)
The following is recommended to be created in Jonas first and then provided to Yellow Dog:
Category Code
Size Code
Color Code
Style Code
Vintage Code
Gender Code
Misc Code
Responsibilities
Client
The client is responsible for initiating the End of Day process in Jonas.
POS Partner
The POS Partner is responsible for setting up their sync’s frequency.
Yellow Dog
Yellow Dog will need to set up an Auth API account and configure the following:
Area Code
Category Code
Vintage Code (Optional)
Gender Code (Optional)
Misc Code (Optiona)
Style Code (Optional)
Yellow Dog will also need to schedule Process Sales application.
Data Exchange
Sales Data
We are provided the following sales data from Jonas:
| Jonas Field | Yellow Dog Field |
|---|---|
| Check Number | TransactionNumber |
| Line Item on Check | Transaction Line Number |
| Check Closed | CheckClosed |
| SKUcode | ItemNumber |
| UPC Reference | SKU |
| SKU Description | POS Description 1 |
| Unit Retail (Before Discounts) | Retail1 |
| Quantity Sold | Quantity |
| Item Discount | ItemDiscount |
| Not Provided | DiscountDescription |
| Not Provided | Tender |
| Not Provided | RegisterNumber |
| Not Provided | RegisterName |
Item Data
The following data is pulled by Jonas:
| Jonas Field | Yellow Dog Field | Created in Jonas First |
|---|---|---|
| Area Code | Interface Setting > Jonas Area Code | x |
| SKUcode | ItemNumber (padded with a "Y" to denote item was created by Yellow Dog) | |
| SKUdescription | POS Description 1 | |
| Category Code | Interface Settings > Category Code | x |
| Size Code | Dimension 1 | x |
| Color Code | Dimension 2 | x |
| Style Code | Style | x |
| Vintage Code | Interface Settings > Vintage Code | x |
| Gender Code | Interface Settings > Gender Code | x |
| Misc Code | Interface Settings > Misc Code | x |
| Retail Price | Retail1 | |
| Member Price | Retail2; if null Retail 1 | |
| Unit Cost | Calculated Cost | |
| UPC Reference | UPC1 if null, SKU | |
| SiteID | SideID (parsed from RVC#) | |
| CompanyCode | CompanyCode (parsed from RVC#) | |
| POSPartitionCode | POSParitionCode (parsed from RVC#) |
The following codes must not exceed a maximum of 5 characters and should be in all caps:
Size Code
Color Code
Vintage Code
Gender Code
Misc Code
Style
The following codes must not exceed a maximum of 6 characters and should be in all caps:
Cateogory Code
System Codes
| Jonas Field | Yellow Dog Field |
|---|---|
| Area Code | Interface Settings > Jonas Area Code |
| Category Code | Interface Settings > Jonas Category Code |
| Vintage Code | Interface Settings > Jonas Vintage Code |
| Gender Code | Interface Settings > Jonas Gender Code |
| Misc Code | Interface Settings > Jonas Misc Code |
Workflows - Where Performed
| Workflow | Yellow Dog Inventory | Jonas POS |
|---|---|---|
| Create Retail POS Items | Done Only in Yellow Dog | |
| Create Restaurant POS Items | Could be Done in Yellow Dog | Typically Done in Jonas |
| Modifer Creation | Done Only in Jonas | |
| Modifer Assignment to Items | Done Only in Jonas | |
| Screen Placement for Items | Done Only in Square | |
| Discount Setup | Done Only in Jonas | |
| Discount Assignment | Done Only in Jonas | |
| Tax Setup | Done Only in Jonas | |
| Tax Assignment | Done Only in Jonas | |
| Area Code Setup | Done Only in Jonas | |
| Area Code Assignment | Done only in Yellow Dog | |
| Category Code Setup | Recommended Creation in Jonas First | |
| Category Code Assignment | Done only in Yellow Dog | |
| Category Code Setup | Recommended Creation in Jonas First | |
| Vintage Code Assignment | Done only in Yellow Dog | |
| Vintage Code Setup | Recommended Creation in Jonas First | |
| Gender Code Assignment | Done only in Yellow Dog | |
| Gender Code Setup | Recommended Creation in Jonas First | |
| Misc Code Assignment | Done only in Yellow Dog | |
| Misc Code Setup | Recommended Creation in Jonas First | |
| Color Code Assignment | Done only in Yellow Dog | |
| Color Code Setup | Recommended Creation in Jonas First | |
| Size Code Assignment | Done only in Yellow Dog | |
| Size Code Setup | Recommended Creation in Jonas First |
Actions in Yellow Dog - Result in Jonas
| Yellow Dog Inventory Action | Jonas Result |
|---|---|
| Item Edited In Anyway and Saved | Update sent to Jonas |
| Item Inactivated | Item is no longer sent to Jonas |
| Item Removed | Item is no longer sent to Jonas |
| Level Is Changed | Change occurs if item inherits new interface setting from Level | Item has POSDescription 1, Publish set to "Yes" and POS Available set to "True", Jonas Area Code Set and Jonas Category Code Set | Item Created |
| Publish set to "No" | Item is not sent to Jonas |
| POS available set to "False" | Item is not sent to Jonas |
| Uncheck Availability to One Store; Item still available to other Stores | Item is made unavailable in POS if made unavailble to that store |
Actions in Jonas - Result in Yellow Dog
| Jonas Action | Yellow Dog Inventory Result |
|---|---|
| Item Returned | Return is processed in Yellow Dog |
| Item Voided | No Change |
| Previous Check Voided | No Change |
| User Created Item in Jonas, not in YD | Once sold, the item will as (unassigned) in POS Only Sales reports |
| User Changed Item Detail in Jonas, not in YD | Changes will be overwritten to what is in Yellow Dog during next sync |
| Item is sold in Jonas that is removed in YD | Sale is processed and assigned to the item as normal; item in YD may be un-removed because on hand has changed. Inventory will be depleted. |
| Item sold in Jonas that is Inactive in YD | Sale is processed and assigned to the item as normal. Inventory will be depleted. |
| Menu Item Sold at POS | Populates in YD POS Item Mapping |
| Menu Item Created at POS | Does not populate in Yellow Dog until Sold |
| Modifier Sold at POS | Populates in YD POS Item Mapping |
| Modifier Created at POS | Does not populate in Yellow Dog until Sold |
| Item Deleted | When a change to the item occurs in Yellow Dog, it will be repushed |
Additional Information
Limitations
Jonas only supports one barcode. As a result, the Yellow Dog SKU is used as the UPC in Jonas.
Jonas requires 8 digits for the Yellow Dog SKU. (9/10/2024)
Discounts are not provided in transaction data.
Additional Notes
For Retail installations -the Jonas Item Number is pre-pended with a “Y” to denote an item that was created in Yellow Dog vs Jonas
One POS integration is supported per Jonas Partition. If the customer is Retail and F&B, there will need to be separate partitions for Retail and F&B.
