This document will provide an
overview of the Yellow Dog/Square integration
Integration Approach
The Yellow Dog/Square integration is a 2 Way Integration
- Sales – Pull from the Square API
- Interface Codes – Pulled from the Square API
- Items (& Images optionally) – Pushed to the Square API
- On Hands (optional) – can be sent to Square via the API. Note: If the option to push on hands is enabled the Square SKU and the Yellow Dog SKU must match. Meaning this function will not work for items that have a UPC1 pushed as the barcode.
Requirements for items to Push to Square
The following must be true for an item to push to Square:
- The item must be set to Publish in the item interfaces
- The item must not be POS Blocked – this can be checked in the interface codes as of sync view. From this view, users can also quickly identify that Publish is enabled, and that the item is available to the primary store.
- The item must be Active and not removed.
- Retail price 1 must be set – if the retail price is $0, then $0 must be entered in the retail field. The system will not accept a blank retail price, however, $0 will be accepted.
- The item must be available to the Square Interfaces store, and interfaces must be assigned in that store.
Square Barcode limitations
NOTE: Square can only accept one barcode from Yellow Dog. If the item has UPC1 in Yellow Dog, then the UPC1 will push to Square. If the item does not have UPC1 then the Yellow Dog SKU will push to Square.
Editing items after they have pushed to Square
The following are best practices for maintaining and editing items after they have pushed to Square.
- Any needed edits, to retail price, description, or SKU/UPC should be made in Yellow Dog and allowed to push to Square.
- Editing any of these fields in Square directly rather than in Yellow Dog will prevent any future updates from pushing to Square and will prevent sales coming into Yellow Dog for these items as expected.
In summary – editing items in Square directly, rather than in Yellow Dog will effectively break the relationship between the item in Yellow Dog and the item in Square.
Creating items directly in Square
If new items are created directly in Square the Yellow Dog SKU can be added in Square, and the system will match the two items to populate sales and deplete on hands. This will work for brand new items that have been created directly in Square. If the item does not have the Yellow Dog SKU in square the sales will come over as unassigned and will not deplete inventory.
Common Troubleshooting Issues
This section will review some of the common issues the helpdesk assists with for the integration between square and Yellow Dog.
UPC assigned to incorrect item
If a UPC has been assigned to an incorrect item in Yellow Dog, remove the UPC from the incorrect item, add it to the correct item and allow the update to push to Square. The next time the sync runs users should see the UPC attached to the correct item.
Parent/Child Items are swapped or Broken
If a parent/child relationship is swapped or broken the items will need to be recreated and allowed to push to Square as new items. Note: Swapping or Breaking parent-child relationships is not recommended with the Square integration.
Pre-existing items added to a matrix or removed from a matrix
If an item needs to be added to or removed from a matrix in Yellow Dog the item(s) should be remade as new item(s) and allowed to Push to Square. Items that have been added to a Matrix or removed from a Matrix after already having been pushed will not be able to be updated in square and sales will not come into Yellow Dog for those items.