Overview

Toshiba consumes the Yellow Dog API for a 1-way integration.  This integration allows Toshiba to post sales transactions to the Yellow Dog Inventory system.


Sync Approach

Toshiba pushes transaction data to Yellow Dog.

The Integration consists of two elements:

  • Toshiba’s process to post sales to Yellow Dog’s API

  • Yellow Dog’s Process Sales Application to process transactions provided by Toshiba in order to deplete inventory

This integration supports multiple Toshiba Locations mapped to a single Yellow Dog Store.

Sync Frequency 

Toshiba’s service posts transactions to Yellow Dog’s API every 15 minutes.

Yellow Dog’s Process Sales Application will be scheduled to run hourly by default.

Requirements

POS Partner

Toshiba is responsible for

  • controlling and scheduling the integration

  • providing documentation/training to the customer with specifics about how to configure necessary elements for this integration in their Admin UI.

Yellow Dog

The minimum version of Yellow Dog Inventory must be v375 or higher and must be hosted by Yellow Dog.

Yellow Dog will provide API Username, password and Client ID to Toshiba.

Yellow Dog will provide StoreIDs to the client for mapping in Toshiba,

Yellow Dog Implementation Guide will need to set up and schedule the Process Sales Application

Responsibilities

Client

The client is responsible for

  • providing Toshiba with a list of YD SKUs for mapping to items in Toshiba (assigned as aliases in Toshiba)

  • mapping stores in Toshiba by populating Yellow Dog’s StoreIds in the YellowDog_storeIDs field in Toshiba’s Admin UI

  • mapping any F&B related sales to recipes in Yellow Dog’s POS Item Map.

Data Exchange and Mapping

Sales Data

Toshiba controls the push of all data transmission via Yellow Dog’s Fetch API v3. 

Note:

  • Returns and modifiers are not supported in Toshiba, and neither are online sales, as this is a kiosk-only system.

  • Users are unable to reopen checks to void items, but items voided before the check has been closed will appear in the transaction data posted to Yellow Dog with quantity=0.

Below are the corresponding data fields:

Yellow Dog FieldToshiba Field
ThirdPartyIDid
TransactionNumbertransactionNumber
TransactionLineNumberItem. Should be the order in which this item was added to the order (e.g., 1, 2, 3, 4, etc..)
CheckClosedcompletionTimestamp
ItemNumberitem.skuId
SKUYellowDog SKU – Elera needs to maintain YellowDog SKU as alias.
Itemitem.description
Item Retailitem.listPrice.value
ItemDiscountItem.priceModifications.valueadjustmentAmount
DiscountDescriptionitem.priceModifications.offerId
QuantityItem.quantity
EmployeeNumbern/a
EmployeeNamen/a
Tenderpayments.paymentTransactions.paymentEntryData.type
Referencen/a
RegisterNumberendpointId
RegisterName‘ELERA’+endpoint

Additional Information

Limitations

  • Refunds are not supported in Toshiba (9/17/24)

  • Modifiers are not supported in Toshiba (9/17/24)

  • Online sales are not supported in Toshiba (this is a kiosk-only system) (9/17/24)

  • Toshiba posts a max of 250 transactions to YD every 15 min (9/17/24)

  • Toshiba does not have a process to get store data from Yellow Dog (9/17/24)