Revel Systems - 2 Way Interface
Last Updated 1/16/2024
Overview
The integration with Revel is a 2-Way interface in which Yellow Dog pulls code data from and pushes new and changed items to Revel Systems via their API and receives sales via Revel’s webhook ability.
Sync Approach
Yellow Dog's sync to push in new/edited items can be run at any interval, but will be scheduled at the top of each hour during business hours by default.
Configuration
This sync does not support
Multiple Revel Instances connected to a single Yellow Dog Database
Multiple Yellow Dog Instances connected to a single Revel Instances
The sync can be configured to run from any location that has access to the Revel API.
Requirements
Client
The client will need to request and sign up for an Integration Services with Revel. There is a $15/Month fee from Revel per integration. The client should reach out to their Account Rep to discuss details.
The client will need to provide Yellow Dog the customer Revel URL and list of establishment numbers.
The client will need to reply to Revel from our Onboarding Request for API credentials and sign the Partner Connect order form.
POS Partner
Revel will provide an API creditenials to Yellow Dog following a request.
Yellow Dog
Yellow Dog will need to email Revel for API credientials.
The following is required from Revel in order to ensure that item and sales data synchronizes correctly:
API URL
API Key
API Secret
Revenue Center / Establishment Codes
User ID to be used for the sync
POS Button Colors, if desired
To enable Webhooks to be used for sales transactions, additional setup is required for both the Yellow Dog and Revel teams.
Responsibilities
Client
Notify Yellow Dog implementation Guide if they have existing Revel Products
POS Partner
TBD
Yellow Dog
TBD
Data Exchange and Mapping
Sales Data
The Yellow Dog sync pulls sales data from the Revel Systems API
Item Data
Yellow Dog pushes the following item data to Revel Systems via their API
| Yellow Dog Field | Revel Systems Field |
|---|---|
| POS Description 1 | Name |
| Retail 1 | Price |
| Calculated Cost | Cost |
| UPC1/UPC2/UPC3/SKU | Barcode (limit 1 in Revel) |
| Revel Sub-Category 1 | Category (required) |
| Revel Sub-Category 2 | Product Sub-Category |
| Revel Sub-Category 3 | Product Sub-Category (Optional) |
| Revel Sub-Category 4 | Product Sub-Category (Optional) |
| Revel Product Class | Product Class (Optional) |
| Revel Button Color | POS Button Color |
| Revel Individual Tax | Individual Tax (Optional) |
| Revel Tax Group | Group Tax (Optional) |
| Revel Show on Kiosk | Affects whether item displays in customer facing apps |
| Revel Show on POS | Affects whether item displays or is searchable/scannable on POS iPad app |
Items can be added to up to 4 Product Categories.
If an item is made inactive or deleted in Yellow Dog, the item is set to “Not Active” in Revel.
System Codes
The Yellow Dog sync pulls in the following codes:
Revel Category
Product Class
Tax Group
Additional Information
Limitations
This sync does not support multiple Revel instances connected to a single Yellow Dog database.
Revel POS is limited to a single barcode per item, between 4 and 16 digits. Yellow Dog's sync will push UPC1 if it is populated with a code longer than 4 digits; if UPC1 is not populated with a valid UPC, the Yellow Dog sync will push UPC2, UPC3, or SKU, whichever has a valid code first.
Additional UPCs are pushed to Revel’s Alternate_lookup field for an item.
Because of the way that Revel Systems receives images, we are unable to push images to Revel's API.
After updating items in Yellow Dog and running the sync, a Refresh is required to update the Revel POS.
After updating items, their placement on the Revel POS screens may change.
Revel has specific limitations to the number of API calls that can be made to their API per day; this can cause delays with initial item pushes into Revel PO
We can only push in items, not modifiers.
Due to the limitation of daily API calls with Revel, the ability to push on hand quantities is not supported. On hand is hardcoded to “0”
Receiptless returns are not supported.
Item’s in Yellow Dog cannot be copied in versions lower than 374.
Due to the nature of webhooks, if a Modifier sale occurs before the modifier data is pulled in during the codes pull, the modifier description will be compromised and cannot be corrected historically. (4/11/2023).
