Overview

The integration with Cliqbux is a 1-way integration that receives sales from the Cliqbux API to deplete inventory levels in Yellow Dog

Sync Approach

Cliqbux pushes transaction data to the Yellow Dog API.

The integration consists of two elements:

  • The Cliqbux process that pushed sales data to Yellow Dog

  • Yellow Dog’s process sales console application to process transactions and deplete inventory

Sync Frequency

The Cliqbux application can be scheduled to every 30 min, 1 hr, 3 hrs, 6 hrs, or daily and is configured in Cliqbux

Requirements

Client

Map Yellow Dog Stores to Cliqbux Establishments within Cliqbux. The Cliqbux team can assist with this step.

Next, confirm how sales will be matched to items in Yellow Dog. You can:

  • Map recipes and items using the POS Item Map

  • Configure the integration to match on Yellow Dog SKU

  • Configure the integration to match on UPC

POS Partner

  • Assist customer with mapping Yellow Dog StoreIDs to Cliqbux EstablishmentIDs

  • Complete setup to post sales transactions to Yellow Dog's API

Yellow Dog

  • Provide API credentials to Cliqbux

  • Provide StoreIDs, along with corresponding Store Descriptions and Codes, to Cliqbux for mapping

  • If matching sales on YD UPC, ensure that the system setting to match on itemAlias has been enabled for the database in Collar


Data Exchange and Mapping

Sales Data from POS

Sales - TPTransaction Third Party Field Notes
ClientSyncID n/a
ThirdPartyID Cliqbux_[transactionNumber]
Converted [thirdPartyId]_[lineNumber]
Revenue Center n/a
StoreID based on location mapping in Cliqbux
SalesChannel n/a
TransactionNumber unique id It will never be repeated in the Cliqbux database for multiple locations.
TransactionLineNumber sequence
CheckClosed sale order time
ItemNumber productID/modifierID
SKU sku
Item product/modifier title
ItemRetail (always positive) price
ItemDiscount (always negative) unit discount
DiscountDescription n/a
Quantity total sold qty
EmployeeNumber employee id
EmployeeName n/a
Source "Fetch-API"
Tender payment id
Reference "Return to Stock" when line is a return
RegisterNumber establishment station id Where the order is created.
RegisterName establishment station name Where the order is created.
ParentNumber thirdPartyLineId of the item being modified by this modifier line
DateKey n/a
Fee n/a
TotalTaxOfTheLine n/a
Void n/a
Return n/a
Order Status n/a
TaxInclusive n/a
Order Number n/a
Sales - General Support
Line Discounts Supported
Check Discounts Supported
Returns Supported
Voids - Line Item Not supported in Cliqbux on closed checks
Voids - Entire Check Not supported in Cliqbux
Modifiers Supported
Tax n/a

Modifiers are supported in this integration. 

Workflows- Where Performed

Limitations

  • SKU must be populated in Cliqbux to match sales to a Yellow Dog SKU or UPC. If the SKU is not populated in Cliqbux, POS Item Mapping must be used instead.

  • Voids are not possible after a sale is completed in Cliqbux. Removing an item from a check after completion will appear as a return in this integration.