Arryved Service Interface
Updated 12/1/2023
Overview
Our Arryved Service Integration supports a 1-way integration where Arryved sends sales data to Yellow Dog via our API.
Sync Approach
This interface contains two elements:
Arryved’s process to push sales data to the Yellow Dog API
A Yellow Dog Process Sales application to process sales transactions posted by Arryved to deplete inventory and update reporting in Yellow Dog.
Sync Frequency
Yellow Dog's SyncwithArryved and Process Sales applications can be run at any interval, but will be scheduled at the top of each hour by default.
Arryved Service's sync application pushes sales data to the Yellow Dog API at a frequency determined by Arryved Service.
Configuration
This integration supports the ability to interface multiple stores in Yellow Dog but requires separate syncs with unique API keys provided by the Arryved team for each store
Requirements
POS Partner
The following is required from Arryved Service in order to ensure that item and sales data synchronizes correctly:
API URL
API Key
A list of all Location IDs (Revenue Center Codes)
Yellow Dog
The Yellow Dog Inventory client must be hosted by Yellow Dog to utilize the API.
To begin Onboarding, Yellow Dog will need to ensure the Arrvyed Onboarding Google Form is submitted.
Yellow Dog will need to provide the following information so Arrvyed can post transactions to our API:
Username
Password
Client ID
Responsibilities
Client
The client will be responsible for creating and mapping recieps to deplete inventory.
The client may be responsible for providing mapping between Arrvyed Location IDs and stores in Yellow Dog.
Data Exchange and Mapping
Sales Data
The Arryved Service pushes sales transaction data to the Yellow Dog API which is then processed using the Process Sales application. This transaction data includes all items sold, not just those that were created by Yellow Dog.
| Arryved Field | Yellow Dog Field |
|---|---|
| Check Number | TransactionNumber |
| Date Time | CheckClosed |
| ObeerID | SKU |
| Name | Item |
| ItemID | Size | Item Number |
| Cost | Item Retail |
| Discount | Discount |
| Discount Description | Discount Description |
| Quantity Sold | Quantity |
| Server ID | Employee Number |
Action in Arryved - Result in Yellow Dog
| Arryved Action | Yellow Dog Inventory Result |
|---|---|
| Item Returned | If provided in sales, this will be reflected in reporting |
| Item Voided | No Change |
| Previous Check Voided | No Change |
| Item is sold in Arryved that is removed in YD | Sales is processed and assigned to the item as normal; item in Yd may be un-removed because on hand has changed. Inventory will be depleted. |
| Item sold in Arryved that is Inactive in YD | Sales is processed and assigned to the item as normal. Inventory will be depleted. |
| Menu Item Sold at POS | Populates in YD POS Item Mapping |
| Menu Item Created at POS | Does not populate in Yellow Dog until Sold |
| Modifier Sold at POS | Populates in YD POS Item Mapping |
| Modifier Created at POS | Does not populate in Yellow Dog until Sold |
Additional Information
Limitations
For Mapping recipes, Menu Items are only presented in Yellow Dog’s POS Item Mapping after being sold.
Other Notes
Yellow Dog will be responsible for supporting their sync; Arryved Service will be responsible for supporting their sync.
