Overview

Yellow Dog's 1-Way integration with Cheq pulls sales and locations from Cheq’s API.

Sync Approach

This integration involves two elements:

  • Yellow Dog’s Cheq Console application to pull sales and locations from Cheq’s API

  • Yellow Dog’s Process Sales Data application that processes sales to deplete inventory and update reporting

Sync Frequency

This integration supports a manual queue that will allow for sales to be retrieved manually on demand by the client or can be scheduled for every 15 minutes.

On hands will be updated as sales are retrieved.

The Process Sales Data application that updates calculated cost and reporting in Yellow Dog will be scheduled to run daily.

Configuration

This integration supports multiple instances of Cheq against the same Yellow Dog database, but has not been tested.

This integration also can pull historical data, but Cheq must provide Yellow Dog with transactionHours or transactionDays to back pull. Without this setting, the sync will pull any orders that have been added or updated in the Cheq API since the last sync.

Sales can be mapped to recipes to deplete inventory using POS Item Mapping or can be matched to items in Yellow Dog by either SKU or UPC to deplete inventory.

Requirements

Client

The client will be responsible for:

  • Mapping Cheq Locations (Cheq Partner Id) to the corresponding stores in Yellow Dog

  • Confirming their preferred method of matching sales to items

    • SKU, UPC, or using the POS Item Map within Yellow Dog

Some configurations may require the client to map recipes to menu items sold to deplete inventory. Please confirm with your Implementation Guide on the approach.

POS Partner

Cheq will need to provide:

  • Cheq API authKey for the Sales API

  • Cheq Partner Ids (LocationIds) if client does not have that data

Yellow Dog

Yellow Dog is responsible for configuring the Cheq Console and Process Sales application.

This integration requires Yellow Dog Inventory version 375+.

Data Exchange

Sales Pull

We pull the following data from Cheq’s API to populate our TPTransactions:

Sales - TPTransactionCheq API
ThirdPartyID"{source}_{siteId}_{revenueCenter}_{transactionNumber}"
Revenue Centerorder.partner_id
TransactionNumberorder.order_id
TransactionLineNumberorder.order.id or modifier.id
CheckClosedorder.created_at
ItemNumberorder.order_items.item_id or variation_id or modifier.item_"{type}s_sku"
SKUorder.order_items.externalSku
Itemorder.order_items.itemName
ItemRetail (always positive)order.order_item.item_price or variant_price or modifier.price
Quantityorder.order_items.quantity
Tenderpayment_method
RegisterNumberorder.deviceId
Modifiersorder.order_items.variant_id
Modifier Priceorder.order_items.variant_price
RevenueCenterorder.partner_id
Sales Channelorder.device_variant
OrderNumberorder.order_number
OrderStatusorder.order_status
isPaymentCancelledorder.payment_status

Sales will be mapped via the POS Item Map in Yellow Dog or matched via SKU/UPC

  • All items in Cheq must have a SKU in Cheq, regardless of whether the client wants to use POS Item Map or match on SKU/UPC.

    • If an item in Cheq does not have a SKU, we will not see any sales for that item.

  • If using the POS Item maps, unsold items are not supported so items cannot be mapped until sold.

The following modifier types are supported in this integration:

  • Additions

  • Toppings

  • Substitutions

  • Variations

Additional Information

Yellow Dog Mobile Application Compatibility

Yellow Dog’s Stand Dog application is compatible with use on the Cheq Terminals. The application is deployed thru Cheq’s MDM and will run directly on the terminal.

Limitations

  1. Voids and Returns are not supported in the Cheq API (10/23/2023)

  2. This integration does not support tax or tender data for accounting exports. (10/23/2023)

  3. Third Party Discounts from Lava, Fortress, Give X and Yinzcam will need to be confirmed and tested when a client using these is onboarded as this information could not be provided (10/23/2023)

  4. For hospitality clients, Loyalty Discounts are not provided in the API and are therefore not supported (10/23/2023)

  5. Unsold items are not avaialble in the Cheq API so items cannot be mapped until sold (10/23/2023)

  6. Side Items do not appear in the API and cannot be supported (10/23/2023)