BirchStreet | Integration Guide

📖 Overview 

BirchStreet Systems is a procurement and inventory management platform that integrates to the Shift4 Point of Sale System for real time inventory product management. This guide explains how to set up and manage the BirchStreet Integration with Canopy 2.0, whether you're using a 1-Way or 2-Way setup.

🔁 1-Way Integration 

In a 1-Way integration, BirchStreet pulls sales data from Shift4 Venue to manage inventory. 

✅ Sales Data Pull:

• There are two ways BirchStreet can pull sales data: 
  • Data exports can be scheduled by the client. Scheduling Exports for Birchstreet 
  • Kinesis feed

⚠️ Important: All item setup and menu management remain in Canopy 2.0 in a 1-Way Integration.

🔄 2-Way Integration 

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

🚫 Do NOT create these in Canopy 2.0 - these are created in BirchStreet:

• Revenue Centers
• Items / Item Assignments
• Modifiers/Modifier Groups/Modifier Group Assignments to Items
• Menus
• Sales Events

⚠️ Important: Users need to update some attributes for sellable products and revenue centers synced against the Menus in Canopy 2.0 once the BirchStreet to Shift4 Venue sync happens. 

⚠️  Fields to Update in Canopy 2.0 after BirchStreet Sync:

• Revenue Centers: Once Revenue Centers sync over from BirchStreet, the following will need to be adjusted manually (Managing Revenue Centers):
  • Timezone
  • Image (Customer Facing Display)
  • Business End Time (This should be set to 3:00AM Local Time)
  • Merchant (This is the Card Not Present Token for Refunds)
  • Additional Fields:
    • Aisle
    • Payment and Tender Settings
    • Tip Configurations
    • Charity Donations
• Menu Data: 
  • Menu Shift4 Merchant (Required for taking payments!)
  • Menu Business Hours (used for Mobile Ordering)
• Item Data: Managing Items
  • Inventory Classification (Levy E15 ID)
  • Barcode
  • Available/Not Available
  • Item Image (For Mobile Ordering/Kiosks)
  • Open Price
  • Tax Group Assignment
  • Classification Flags: 
    • Alcohol 
    • Discountable
    • Open Modifier
  • Categories: 
    • Display Category (BirchStreet sends 1 default category for all items. If you want items separated on the Point of Sale, this must be mapped)
    • Report Category

✅ Configure/Maintain in Canopy 2.0:

• Tax Groups: Must be configured in Canopy 2.0 and mapped to each item in item setup after the new item is synced over. 
• Display Categories: Must be configured in Canopy 2.0 and mapped to each item in item setup after the new item is synced over. 
• Report Categories: Must be configured in Canopy 2.0 and mapped to each item in item setup after the new item is synced over. 
• Mobile Ordering setup
• User Accounts
• Print Routing
• Discounts and Custom Tenders
• Service/Delivery Fees & Seat Mapping

⚙️ Sync Guidelines & Best Practices

• Once new data is synced over from BirchStreet, please be sure to review all the manual fields that need to be programmed for each new RVC and Item. 

🔄 1-Way Sales data is sent real time via the Kinesis Stream. 2-Way Data is sent from BirchStreet to Shift4 Venue in real time when changes are found. Depending on the updates made, it could take up to 6 minutes to appear on the point of sale. The integration runs concurrently and independently for each enabled venue, not one venue at a time. 

📬 Need Help? Open an internal service request ticket with Levy