Appetize Interface
Last Updated 1/22/2024
Overview
Our Appetize interface supports a 2-Way integration in which Yellow Dog Inventory can pull sales data Appetize while Appetize pulls new and changed items from Yellow Dog’s API.
Sync Approach
Appetize consumes the Yellow Dog API to pull new/changed item information.
Yellow Dog Software consumes the Appetize API to pulls sales information.
Sync Frequency
Appetize controls the frequency that items are pulled from Yellow Dog’s API. By default, the Sales Pull is scheduled to run hourly however additional scheduling options are available upon request.
Requirements
Client
The client will need to make sure the store codes provided to Yellow Dog do not match Revenue Centers (Vendor IDs) in Appetize. Additionally Yellow Dog Sync program will need internet access to exchange information with the Appetize API.
POS Partner
Yellow Dog will provide the following detail to Appetize:
API Username
Password
Client ID
The Yellow Dog Client must be hosted by Yellow Dog to utilize the API.
Yellow Dog
From Appetize, Yellow Dog requires the following:
API Url
API Key
API Version
VendorID
VenueID
Data Exchange and Mapping
Sales Data
| Appetize Field | Yellow Dog Field |
|---|---|
| order order_id | Transaction Number |
| item row_id | Transaction Line Number |
| order date_completed | Check Closed |
| item id | Item Number |
| item sku | SKU |
| item name | Item |
| item additional_items | Modifiers |
| mod cost | Modifiers - Item Retail |
| mod discount | Modifiers - Item Discount |
| Item Orginial_Cost | Item Retail |
| item discounts_applied and order discounts_applied | Item Discounts |
| item quantity | Quantity |
| order employee id | Employee Number |
| order employee employee_name | Employee Name |
| payment card_type or payment_type_name | Tender |
| payment amount or payment_amount | Tenders - Amount |
| payment payment_type | Tenders - Descripiton |
| tax tax | Taxes - Amount |
| tax name | Tax Descripiton |
| Order Status | Completed, Refunded, Partial_Refund |
| item discounts_applied | Line Discounts |
| order discounts_applied | Check Discounts |
| order status="refunded" or "partial_redund" and refund_item_quantity is not null/empty | Returns |
Order discounts are divided across all items in the order.
For Appetize Legacy customers, Refunds occur on original order. Newer versions of Appetize provided Refunds as separate orders linked back to the original order.
Item Data
| Yellow Dog Field | Appetize Field |
|---|---|
| GenericCodeA | Item Type |
| RevenueCenterNumber | Vendor ID |
| SKU | Yellow Dog ID (External ID) & UPC |
| UPCs | Universal Product Code |
| Description, Dimension1 + Dimension2 | Item Name |
| Default Retail | Price |
| GenericLevelA | Primary Report Category ID |
| GenericCodeC | Secondary Reporting Category |
| GenericCodeD | Third Reporting Category |
| GenericLevelB | Tax Group ID |
| GenericLevelC | Category Group ID |
| Active | (In)Active |
| Deleted | Deleted |
| LastUpdated | LastUpdated |
| PublishFlag | Vendor Assignment |
Appetize will populate the Yellow Dog SKU as the external ID for API reporting and Barcode. If no SKU is present, this data will be populated with the UPC of the item.
System Codes
| Appetize Field | Yellow Dog Field |
|---|---|
| Item Type | GenericCodeA |
| Primary Reporting Category | GenericLevelB |
| Secondary Reporting Category | GenericCodeC |
| Third Reporting Category | GenericCodeD |
| Tax Group ID | GenericLevelA |
Additional Information
Our sync will work with both Connect and Activate Classic and Activate X versions of Appetize.
This integration is compatible with YDI Version 372.
Limitations
Yellow Dog Software attempts to list any known limitations with each integration. The below list is what our team is aware of, but by no means, is guaranteed to be complete or exhaustive.
Matrix Items will appear as individual items in Appetize. There is no Matrix presentation.
All items in Yellow Dog are made available in Appetize regardless of status (publish, etc.)
Items are not store specific
Display Name is not being pulled from YD POS1
Commission Groups are not supported
Images are not supported
On hand is not pulled or updated from Yellow Dog Inventory
COGS are not pulled from Yellow Dog Inventory, No Cost is Shown in Appetize
Vendor Name/Code is not pulled from Yellow Dog Inventory
Supplier ID (Vendor SKU) is not pulled from Yellow Dog Inventory
Special characters in SKU or UPC field are not supported (numeric or alpha only)
Item Name has a 200 character max.
Tax Types are not provided in Return detail and will appear lumped together as “Additional Tax”
Custom Refund amounts are not supported (refunds on payments not tied to a specific item)
Other Notes
** WARNING ** - PLEASE CONFIRM WITH SPOT ON THAT THE TERMINALS YOU HAVE FOR POS CAN 1. LAUNCH A BROWSER AND 2. HAS THE 4.X VERSION OF ANDROID 10
Stand Dog Mobile App for Browser
The Stand Dog mobile app for browser can be launched/operated from the Appetize ActivateX POS system. This ability does NOT exist in Activate Classic.
The video of this can be watched here.
Bloodhound Mobile App for Browser
The Bloodhound mobile app for browser can be launched/operated from the Appetize ActivateX POS system. This ability does NOT exist in Activate Classic.
Configuring these URLs in Spot On Enterprise (Appetize ActivateX)
Help article here.
ELO Terminals
Requires ActivateX and 4.x Android 10
Minimum Elo Terminal specifications:
Elo Version 4.62.39+a
BSP: 4.62.30-pilot+a
APK Version: 4.62.30
Product Version: 3.0
Android Version: 8.1.0
Appetize Version 5.0
NTEP CC: 18-XXX
PAX Terminals
Yellow Dog Software’s Stand Dog Android app is in the PAX Store and may be installed on to certified PAX Devices. The list of certified devices includes:
e700
A930
Other devices are under investigation including e800 and A920.
