Yellow Dog | Integration Guide

Article author
Caden Loza
  • Updated

๐Ÿ“– Overviewย 

This guide explains how to set up and manage the Yellow Dog integration with Canopy 2.0, whether you're using a 1-Way or 2-Way setup.


๐Ÿ” 1-Way Integrationย 

In a 1-Way integration, Yellow Dog pulls sales data from Shift4 Venue (via item SKUs) to manage inventory. All item setup and menu management remain in Canopy 2.0.

โœ… Setup Guidelines:

  • ๐Ÿ”ง Items must be created in Canopy 2.0 with proper SKUs
    • If Yellow Dog is already in use, SKUs may come from them
    • Otherwise, create SKUs in Canopy and send to Yellow Dog
  • ๐Ÿ” Modifier SKUs are always created in Canopy 2.0
  • ๐Ÿ›‘ If Yellow Dog has an existing database, delete all items in Canopy and rebuild using Yellow Dog SKUs
  • ๐Ÿ“ฆ Menu, pricing, and item updates must also be manually reflected in Yellow Dog to ensure inventory accuracy

๐Ÿ“‹ Configure before Yellow Dog training begins:

  • Locations
  • Menus
  • Display Categories
  • Modifier Groups
  • Report Categories

โš ๏ธ Important: All changes to Revenue Centers, Menus, Item Names, or SKUs must also be updated in Yellow Dog to prevent inventory issues.


๐Ÿ”„ 2-Way Integrationย 

In a 2-Way setup, Yellow Dog can both pull sales data and push item data into Canopy 2.0. Yellow Dog becomes the source of truth for item creation and changes.

๐Ÿšซ Do NOT manage these in Canopy 2.0:

  • Adding/removing items from menus
  • Item Level Discount Flags
  • Changing item names, prices, and SKUs
  • Location settings or price levels
  • Single Tax Rates
    • If there is only 1 tax rate for the entire venue, then we receive this from the Yellow Dog 2-Way push.
    • If there are several tax rates in a venue/group, then these are managed on the Canopy 2.0 side.

โœ… Still configure/maintain in Canopy 2.0:

  • Revenue Centers & Menus
    • For example, new locations, menus, or renaming them. If renaming them, make sure to reflect that change in Yellow Dog. Do not assign items to menus in Canopy 2.0.
  • Mobile Ordering setup
  • Display & Reporting Category creation
  • Modifier mapping
  • User Accounts
  • Item Images & Print Routing
  • Discounts, Tenders, Per-item Tax Rates
  • Service/Delivery Fees & Seat Mapping
  • Taxes ONLY if more than 1 rate exists in a group

๐Ÿ“ฅ Yellow Dog will send these item fields to Canopy 2.0:

  • name, uuid, external_ref_id, price, description
  • inventory_state, product_sku, display_name
  • modifier flag, combo_meal flag, taxable flag
  • tax_inclusive flag, venue_uuid, discountable flag
  • menu_uuids, item_category_uuids

๐Ÿ“ Modifier Items & Categories must still be maintained in Canopy 2.0.


โš™๏ธ Sync Guidelines & Best Practices

  • Review item mappings in Canopy after the first sync
  • Manual syncs only โ€” Auto Sync should be turned off
  • Always sync at least 1 hour before an event

๐Ÿ”„ Data is synced in real-time between Shift4 Venue and Yellow Dog via Kinesis Streams.

๐Ÿ“ฌ Need Help? Email: support@yellowdogsoftware.com
Portal: Yellow Dog Support Portal

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.