GoTab 1-Way Integration
Last Updated 7/26/2023
Overview
Yellow Dog's 1-Way integration with GoTab pulls sales and locations from GoTab’s API.
Sync Approach
This integration involves two elements:
Yellow Dog’s GoTab Console application that pulls locations and sales from GoTab’s API
Yellow Dog’s Balto application to assign locations from GoTab to stores in Yellow Dog.
Sync Frequency
The sync application can be configured to run at any interval. By default this will be configured to run hourly.
Configuration
This integration supports multiple locations (GoTab’s Zones) tied to a single Yellow Dog database.
This integrations supports two methods to map Sales for inventory depletion:
Menu Items and Recipes are mapped to the POS Item Sold using Yellow Dog’s POS Item Mapping. This is the recommended approach if a customer is using modifiers.
Sales can be matched to Yellow Dog Items based on SKUs but requires the YD SKU be added to GoTab’s Inventory. This is only recommended for Retail clients with no modifiers.
The client will access their Inventory Module and click the Download Inventory Catalog button. From there, they will fill in the “external_sku” field with the YD SKU and save the document. Back in the inventory screen, the client will click the Upload Inventory Catalog button and this will then populate the inventory items in GoTab with the YD SKU
Please confirm the preferred method with your Implementation Guide.
Requirements
Client
The client will be responsible for:
Providing the mapping of GoTab’s Zones to the stores in Yellow Dog
Determine the sales mapping approach for inventory depeletion outlined in configuration
POS Partner
GoTab will need to provide:
GoTab ClientID and Secret
GoTab SiteID as it relates to stores in Yellow Dog
Yellow Dog
Yellow Dog is responsible for configuring the GoTab Console.
This integration requires Yellow Dog Inventory version 375+.
Data Exchange
Sales Pull
We pull the following Sales information:
Yellow Dog Field | GoTab API |
---|---|
ThirdPartyID | tabID |
Revenue Center | locationId |
TransactionNumber | tabUuid |
TransactionLineNumber | lineItemNumber |
CheckClosed | closed, else created |
ItemNumber | productID |
SKU | sku/externalsku |
Item | itemName |
ItemRetail | item.UnitPrice |
ItemDiscount | adjustment.isdiscount or isfee |
DiscountDescription | adjustment.name |
Quantity | quantityInitial |
Reference | href |
Void | item.voided |
Return | item.comped |
Additional Information
Limitations
Open refunds are not supported; the refund must be associated with the item.
Modifiers do not have their own SKU/ItemNumber in GoTab so they do not show up as unsold items
This integration does not pull in Tax, Tender or Fee data.
GoTab allows for a single order to be assigned to multiple zones. We can not support multiple zones in YD
Example: the check is opened in one zone, but then updated and closed in another
In those cases, YD will use the first zone presented to us in their API for that order
Matrices must be configured as Variants in GoTab. Variants must be turned on by GoTab for the customer’s environment.
We do not support variants with multiple option types.