Vivaticket - 2 Way Integration
NOTE: This integration is developed custom for each install. The partner has a dynamic approach which we have to evaluate and scope for each install. A quote for custom development will be required.
Last Updated 9/11/2024
Overview
The integration with Vivaticket supports both a 1-way Sales Pull that pulls codes and sales data from Vivaticket’s SQL Databases and a 2-Way integration that pushes item data to Vivaticket using their BOS Soap API.
Sync Approach
This interface contains two elements:
Yellow Dog’s SyncYdiWithVivaticket
Vivaticket’s BOS Soap API
Yellow Dog’s SyncYdiWithVivaticket will need to be installed on the vivaticket server.
Sync Frequency
The sync by default will be scheduled to run hourly.
Configuration
This integration does NOT support multiple instances of Vivaticket against a single instance of Yellow Dog.
This integration does support multiple Vivaticket Events (locations) within the same Vivaticket instance, each mapped to a separate Yellow Dog Store.
This integration does NOT support multiple RVC codes (Vivaticket Events) per Yellow Dog Store. Yellow Dog Stores and Vivaticket Events must have a one-to-one relationship.
All Items created in YD and pushed to BOS will have the SKU prepended with ‘YD’ as the Product Code. In BOS, the SKU will have the prepended “YD” and will have the associated StoreCode appended.
This integration also supports the ability to pull in unsold menu items to map.
Requirements
Client
The client will need to decide the Product Name, Description and Additional Description fields to use and provide to Yellow Dog.
For 1-Way Integrations the client will be required to do one of the following in order to deplete Inventory:
Create and map recipes to the items sold in Vivaticket
Match SKU in Yellow Dog to Product Code in Vivaticket
POS Partner
The POS Partner must provide:
Vivaticket SQL Connection including - Server Name, Database Name, Database User ID & Password
Vivaticket API Connection (if pushing items) including API URl, API Username & Password, API Workstation AK, SessionID (API Token)
Additional data provided by POS Partner Needed:
SystemID
SiteID
RVC (operating area codes)
Number of Statistical Group Codes
List of Product Type Codes that should be supported
The following must be configured before installation:
Matrix Sheets
Matrix Sheets MUST be Flat
Note that this integration only supports one Matrix Sheet per store (Vivaticket Event)
Chart of Accounts in Matrix Sheets
Codes
Modifiers
Yellow Dog
Yellow Dog will need to configure the the number of Statistical Group(s) in the sync (this is typically 3), ProductName, Description and Additonal Descripiton options.
Data Exchange and Mapping
Sales Data
We pull in the following data from Vivaticket:
| Vivaticket Field | Yellow Dog Field |
|---|---|
| {Source}_{SiteID}_{RVC}_{TransactionNumber} | ThirdPartyID |
| {tpt.ThirdPartyID}_{tptr.TransactionLineNumber} | Converted |
| Sale.Key | TransactionNumber |
| item.TransactionLineNumber or Modifer.SaleitemComboID | Transaction Line Number |
| Check Closed | Check Closed |
| Product Code | ItemNumber |
| User Number | Employee Number |
| User Name | Employee Name |
| Payment Names | Tender |
| Transaction Type | Reference |
| Register Number | Register Number |
| Register Name | Register Name |
| Vivaticket Data | Yellow Dog TPTransactionDetail |
| Item Tax | Tax Amount (sync has to compute using Unit Tax * Qty) |
| Payment Name | Tender Descripiton |
| Payment Amount | Tender Amount |
Sales match on the Vivaticket Product Code.
Item Codes
| Vivaticket Field | Yellow Dog Field | Additional Info | |
|---|---|---|---|
| Matrix Sheet | Vivaticket Matrix Sheet Price List | Limit ONE Matrix Sheet Price List per Store in Yellow Dog. This setting CANNOT be changed after an item has been pushed. | |
| Price List | Vivaticket Matrix Sheet Price List | ||
| Price Type | Vivaticket Price Type | ||
| Stock Product Category | Vivaticket Stock Product Category | This setting CANNOT be changed after an item has been pushed | |
| Tax Type | Vivaticket Tax Type | ||
| Unit of Measure | Vivaticket Unit of Measure | This setting CANNOT be changed after an item has been pushed. | |
| Receipt Not Required | Vivaticket Receipt Not Required | ||
| Not Refundable | Vivaticket Not Refundable | ||
| Tax Package | Vivaticket Tax Package | ||
| Statistical Group | Vivaticket Statistical Group | Mutliple are supported | Product Name | Can be set to any of the following, Description, POSDescription1, POSDescription2, ShortDescription | Description | Can be set to any of the following, Description, POSDescription1, POSDescription2, ShortDescription | Retail | Retail1 | Must be non-$0 | Variable Min Price | Retail2 when VivaticketPriceType=Variable | See Limitations below | Variable Max Price | Retail3 when VivaticketPriceType=Variable | See Limitations below | SKU | YD[SKU][StoreCode] | Status | Active | We will only push new items that are Active; we can update items to be inactive, but cannot update inactive items to be active again in Vivaticket’s API | Barcodes | SKU + UPCs | Barcodes cannot be updated via Vivaticket's API after the item has been created in Vivaticket | Product Code | YD[SKU] |
Additional Information
Limitations
All sales and item details described above can vary depending on the version of Vivaticket. Some additional development may be required to support 2-Way integrations.
Vivaticket has a number of limitations in the API regarding what can and can not be updated after an item is pushed to Vivaticket for the first time. Some item details will need to be managed long term in Vivaticket.
Yellow Dog only supports using Combos to associate Modifiers with items.
Refunds do not include modifiers only the main item. All cost associated with a refund is tied to main item including tax.
Vivaticket currently has a bug that the Min and Max quantity must be used for combos to ensure the quanity of the modifier is available in the sales pull
Recommendation: If the modifier should increase the price of the main item, the Delta Price must be used to designate the additional cost to associate with the modifier. This cost is included with the modifier in our sales pull for accurate reporting.
All items pushed to Vivaticket are pushed as individual items (Yellow Dog matricies and parent/child items are NOT treated any differently or grouped together)
Variable pricing is not supported due to API limitations
Yellow Dog does not control web/online item details in Vivaticket. This is not supported in their API.
Setting an item’s status (active/inactive) is not supported in their API.
Limit one matrix sheet per YD Store; the assigned matrix sheet can NEVER be changed after items have been pushed from YD
