Magento Web Shopping Cart Interface
Last Updated 5/27/2021
Overview
With our two-way integration, Yellow Dog uses Magento’s API to create new items, update item changes, update on hand counts, pull codes and process orders to update sales and reduce on hands.
Sync Approach
Yellow Dog uses SyncYDIWithMicroServices and Magento’s API to update the item properties and process orders.
Sync Frequency
Typically the sync is configured to run hourly.
Requirements
Client
TBD
POS Partner
TBD
Yellow Dog
The following are needed from Magento:
URL (main URL for the Customer’s Mageno Site)
Access Token
Store View Codes
Max number of Categories that will be assigned to a product
Responsbilities
Client
The client will need to determine if they want the following set up
Push Cost (Default Vendor Price in Yellow Dog)
Push On Hands (Options are No, Store only, Total on Hand All Stores)
The client will need to export all pre-existing items in Magento they want matched in Yellow Dog. There might be additional setup and configuration needed to match items. Please consult your Implementation Guide.
POS Partner
TBD
Yellow Dog
TBD
Data Exchange
Sales
The following fields are pulled into Yellow Dog from Magento:
Magento Field | Yellow Dog Field |
---|---|
Order Date | CheckClosed |
Magento's Product ID | ItemNumber |
SKU | SKU |
Product Name | Item |
Originial Price | Item Retail |
Discount Amount (divided by quantity) | Item Discount |
"Microservice_MagentoSales" | Source |
Order ID | Transaction Number |
Refund or Cancelled Order Designation | Reference |
Items
The following item details are pushed to Magento:
Magento Field | Yellow Dog Field |
---|---|
SKU | SKU |
Product Name | WebItem.Title, else Item.Description |
Short Description | Web Properties Short Description |
Description | Web Properties Extended Descripton |
Price | Item Retail |
Cost | Default Vendor Cost |
Length | Length |
Width | Width |
Height | Height |
Weight | Weight |
Images | Pictures |
Image Roles | |
Quantity | On Hands - By Store or Total |
Stock Status | We set this to "In Stock" when On Hand > 0, and "Out of Stock" when On Hand < 0 |
Enable Product | Once we have pushed an item to Magento, if it is ever made inactive/removed/unavailable/sendtoweb=false in YD, we disable it in Magento |
Size | Dimension 1 |
Color | Dimesnion 2 |
Attribute Set | MAgento Attribute Sets (Required) |
Categories | Magento Category [x] |
Tax Class | Magento Tax Class |
Visibility | Magento Visibility |
Codes
The following are the codes pulled in from Magento’s API:
Magento Field | Yellow Dog Field |
---|---|
Magento Attribute Sets | Varies based on client |
Magento Category [x] | The number of Magento Category dropdowns is based on the API Sync Config detting |
Magento Tax Class | |
MAgento Visibility |
Limitations
Multiple Magento instances against a single Yellow Dog Database is not currently supported.
All returns will have the same CheckClosed date as the original sale
All refunds are treated the same and will return the items to stock
Magento does not provide line item detail for taxes on returns; our code does additional work to break this out that may result in rounding discrepancies in some cases
We push attribute sets for item but we do not push attributes themselves except for Size and Color.
Implementation
Yellow Dog SKUs must match any pre-existing Magento SKUs
Dimension descriptions for sizes and colors in Yellow Dog must match exactly with the size and color descriptions in Magento.