Overview

Yellow Dog's integration with Square supports RFID-based inventory counting. Items are created directly in Square, then pulled into Yellow Dog via the sync. From there, users perform physical inventories (PIs) in Yellow Dog using RFID, then manually trigger the sync to push on-hand updates back to Square.

This integration is intended for RFID-based counting only. It is not intended for sites using SquareConsole or any other traditional POS integration.

Sync Approach

This interface contains multiple elements: 

  • Items are pulled into Yellow Dog from the Square API 

  • On Hands are pulled from the Square API and compared to the on hands in Yellow Dog to create Manual Adjustments in Yellow Dog

  • On Hands are pushed into square via the Yellow Dog API

Sync Frequency

  • Items and on hands pulled into Yellow Dog - can be scheduled hourly or daily

  • On hands pushed to Square - manually pushed to Square from within Yellow Dog 

  • Sales - N/A

Requirements

Yellow Dog

  • Confirm that the Yellow Dog database is v376 or higher 

  • Confirm that .Net 10.0 is installed on the server 

  • Create a new Admin API user via Collar for the integration and securely save the password 

Client

  • Identify one or more people with admin permissions in the Square account

    • This person will join a call with our Installer to complete the initial Square connection — logging into Square during Proxy setup and granting YD's sync the access it needs going forward.

  • Confirm the name of the single Square Location that will be used for this integration

    • This is the only Square location the sync will pull items and on hands from and push on-hand updates to.

  • Confirm the YD Store that will be used for this integration

    • Usually there will only be one store in the YD database used for this integration

  • Confirm the look-back window for physical inventories — the number of hours between a PI's Effective Date and the sync run that pushes on-hands based on it

    • Default is 1 hour

  • Provide email address(es) that should receive any error notifications

Data Exchange

Item Data

SquareRFIDConsole pulls item data from Square to create items in YD.

YD Item Properties Square Properties Notes
Description Name
Item Retail Price
Cost Price
SKU SKU
UPC GTIN
Level1 Default: "SquareRFID"
Level2 Reporting Category If there isn't a Reporting Category assigned to the item in Square, the item will be assigned directly to the Level1.
Dimension1 Measurement Unit Units from Square are created as Dimension1s in YD and assigned based on the unit assigned to the item in Square.
Store Sync assigns the item to the Store selected in the sync config.
Active Flag Sync sets this to true.
POS Block Item is created with POS Block true.
On Hands When pullOnHands runs, the sync compares the on hands of the items in Square in the configured location and the same items in YD in the configured store, and creates manual adjustments in YD to ensure that the YD on hand matches the Square on hand.

NOTE: This will be skipped in any sync runs that will push on hands to Square from a valid PI to prevent conflicts and variances.

On Hand Data

SquareRFIDConsole

  • Pulls on hand counts from the configured Square location and compares them to the on hands for items in the configured YD store, then creates manual adjustments in YD to ensure that the YD on hand matches the on hand in Square.

    • NOTE: any sync runs that will push on hands to Square from a PI that meets the requirements below will NOT pull on hands from Square on that run. This is by design to prevent conflicts and variance issues.

  • Pushes on hand counts to Square from PIs committed in the configured store.

The requirements for an item on hand to push from a PI in YD is as follows:

Requirement Additional Information
PI must have been created and committed in the store configured for the integration.
PI must have an effective date within the physicalLookBackTime (default = 1 hour).
PI must not have already been pushed by the sync.
The items must have been matched to items in Square (whether the items were created by the sync or not). If there are items on the PI that are NOT matched to items in Square, the on hands for the items that ARE matched will still push over.

NOTE: The on hands will be updated in Square using the effective date from the PI; i.e., the on hand update in Square will be based on the effective time of the PI and NOT the time of the sync run.

Limitations

  • Only one store per integration is supported. 

  • This integration is intended for sites that are only using YD for physical inventories, so item creation and updates are NOT geared towards sites tracking item cost or pushing items to a POS 

  • Creates individual items in YD only 

    • If items are in a matrix in Square, they are pulled into YD as individual items only