Overview

We have many custom syncs to handle the integration with various point of sales systems. This specification details our Sales Sync which is a 1-way sales processing application. If you need a 2-way integration, please look at our Generic Sync or our API.

With the Sales Sync we are able to consume transactional or daily summarized sales data.

Sync Approach

Yellow Dog Inventory will pull sales detail from .csv files from local folder that our sync has access to or a FTP location.

Sync Frequency

The sync can be scheduled to run at any interval but will be configured to run based on the schedule that the .csv file(s) will be made available from the Point of Sale.

Configuration

The Sales Sync does not require the sales data to be in a specific order nor follow any specific rules in header naming.

The sync allows for dynamic configuration and mapping of the sales columns or headers to the equivalent field in Yellow Dog.

Requirements

POS Partner

The POS Partner needs to provide the following detail:

  • Specification on if Summary or Transaction Level detail sales information will be provided

  • Sample file(s) as requested below

  • Know whether the site will be using modifiers and if so, whether they should be concatenated

  • The method for matching POS Items to YD Items

  • The method for matching POS Store to YD Stores

  • FTP location or local folder for POS Sales File exports

Sample Sales File

To determine if this sync is the best approach for an integration, a sample sales file will be requested for review.

The sample sales file should contain the following sale examples:

  • Return

  • Void

  • Comp

  • Discount

  • Sale

  • Modifier

The following details the required and optional fields for both a Transaction Level and Summary sales file.

Sales DataSummary FileTransaction Level Detail File
Item NumberRequired for POS Item MappingRequired for POS Item Mapping
SKURequired if Item Number/Item ID not providedRequired if Item Number/Item ID not provided
Item DescriptionRequiredRequired
Quantity SoldRequiredRequired
Unit RetailRequiredRequired
Unit DiscountN/AOptional
Check ClosedRequired Date OnlyRequired Date and Time
Transaction NumberN/ARequired
Line NumberFile placement will be usedOptional otherwise File placement will be used
Revenue CenterRequired if StoreID not provided and more than one Store is selected in the syncRequired if StoreID not provided and more than one Store is selected in the sync
TenderN/AOptional
Discount DescriptonN/AOptional
Register NameN/AOptional
Register NumberN/AOptional
Base RetailOptionalOptional
Employee NumberN/AOptional
Employee NameN/AOptional
Item IDOptionalOptional
Store IDRequired if Revenue Center not provided and more than one Store is selected in the syncRequired if Revenue Center not provided and more than one Store is selected in the sync
TaxOptional - supports values formatted like 0.65, .15, and 1.12Optional - supports values formatted like 0.65, .15, and 1.12
Is ModifierN/AOptional
Modifier Parent Product IDN/AOptional - ItemNumber of the item being modified; should be populated on modifier rows only

Please note the following data expectations:

  • For Quantity Sold - positive quantity denotes a sale, negative quantity denotes a return

  • For Unit Retail - this number should always be positive

  • For Unit Discount - this number should always be negative

If a Check Closed time cannot be provided, the sync has a configuration option called “Enable Time Part Override” that will allow for a selected time to be assigned to all transactions.

Example Files:

Download example files here:

Sales Summary

Transactional Data

Responsibility

Client

The client will be responsible for providing the matching of Revenue Centers to the correct store(s) in Yellow Dog to ensure that sales are mapped to the correct inventory locations.

The Client is also responsible for mapping recipes to the POS menu items for inventory depletion.

POS Partner

The POS Partner is responsible for configuring the export of the sales file and providing to the agreed upon FTP location. The schedule of the export should be provided to Yellow Dog so the sync schedule can be configured accordingly.

The POS Partner will need to work with Yellow Dog to ensure the proper mapping of the sales data from the file to the fields in Yellow Dog.

Yellow Dog

Yellow Dog will need to configure the sync to ensure all the sales data mapping is complete and schedule the sync to run.