Overview

The integration with WooCommerce has a complete 2-way sync that pulls sales and codes from Woo Commerce and pushes item and image data.

Sync Approach

This sync uses Woo Commerce’s API to

  1. Create new items (complete details, variants, pictures, etc)

  2. Update any item changes

  3. Update on-hand counts

  4. Process orders from items sold and reduce on-hand amounts

The sync can be run from any location that can access the API.

Sync Frequency

The sync can be scheduled to run at any interval. By default, it will be run at the top of every hour during business.

Configuration

This sync supports multiple configurations. Please consult with your Yellow dog Implementation Guide to determine the appropriate option for you business need(s):

  • Pull Sales Only

  • Push On Hands + Pull Sales

  • Push Items and NOT on hands + Pull Sales

  • Push Items AND On hands + Pull Sales

Additional Configuration Option

Our integration with WooCommerce supports the staging of unfulfilled sales. This optional features will allow the on hands to update based on unfulfilled sales by using a “holding” store for that inventory until that sale is fulfilled. This allows for more accurate on hand updates to additional integrations used in conjunction with Woo Commerce and Yellow Dog Inventory. For additional information, your Implementation Guide or a member of our Support team will be able to assist.

Requirements

Client

The client will need to create a NEW WordPress User for the integration. This should be separate from their regular users.

  • This user will need Read/Write permissions in order to generate an API Key.

  • This user will require a minimum of Store Manager role.

POS Partner

Assistance from Third Party Site Developer or WooCommerce might be required for granting Yellow Dog http authorization code to htaccess in order to connect the sync to WooCommerce.

Yellow Dog

To sync with WooCommerce, we will require: 

  • API URL

  • An API Key for use with the Sync (WordPress is the parent website).

    • Read/Write Permissions

  • Client Secret

Data Exchange and Mapping

Sales Data

Our sync pulls transaction data (Orders) from the Woo Commerce API regardless of status.
We are unable to pull returns from Woo Commerce.
Yellow Dog Inventory pulls the following transaction data:

Woo Commerce FieldYellow Dog Field
Date Created Check Closed DateTime
Product ID_Variation IDItem Number
SKU SKU
Product Title,plus Attributes for Variations POS Item
Cost Item Retail
Discount Item Discount
Coupon (s) Discount Description (support multiple)
Quantity Sold Quantity
Order Number Transaction Number
(Placement in order lines array) Transaction Line Number

Item Data

We will push the following item data to WooCommerce when the following requirements are met:

  • Send to Web is True

  • Item Is availble to the Store in the Sync

  • Item Is Active

  • Item is Not Removed

Woo Commerce YD Single Item YD Matrix Item
Product Name Web Properties Title, else POS1 Matrix Web Properties Title, else Matrix Short
Product Short Description Web Properties Short Description Matrix Web Properties Short Description, else Matrix Short Description
Product Long Description Web Properties Extended Description Matrix Web Properties Extended Description, else Matrix Description
Regular Price Retail 1 Retail 1
SKU SKU (1 per product/item) SKU (1 per variation/matrix item)
Sale Price Web Properties Sale Price Can be set per matrix item
Sale Price Dates Web Properties Sale Dates Can be set per matrix item
Product Tags Notes Matrix Notes
Attributes Dimensions 1,2,3 Dimensions 1,2,3
On Hands Item on hand Item on hand
Product Image Picture 1 Picture 1 for the Placement 1 matrix item
Product Gallery Picture 2,3 All other pictures for items in the matrix
Publish-Catalog Visibility Woo Commerce Catalog Visibility Shared across matrix
Product Categories Woo Commerce Category 1-3 Shared across matrix
Shipping Class Woo Commerce Shipping Class Can be set per matrix item
Publish - Status Woo Commerce Status Shared across Matrix
Tax Class Woo Commerce Tax Class Can be set per matrix item
Tax Status Woo Commerce Tax Status Shared across Matrix

In order to Push on Hands Only the following is required:

  • Item is not POS Blocked

  • Item SKUs in YD and WooCommerce Match

  • Matrices in YD and WooCommerce have the same variable products and same matrix sku

System Codes

We will import the following code data: 

  • Catalog Visibility

  • Categories

  • Shipping Classes

  • Statuses

  • Tax Classes

  • Tax Statuses

Additional Information

Limitations

  1. Each store will require its own Sync.

  2. WooCommerce allows for one SKU per item.

  3. In WooCommerce, refunds are for dollar values only; because refunds are not associated with items, we are unable to retrieve returns from WooCommerce.

  4. For pre-existing items, we are unable to pull images from Woo Commerce.

  5. Orders are pulled in regardless of Status (this is not necessarily a limitation, but with most of our syncs, we tend to rely on some kind of completed/closed status before pulling in sales).

  6. Before YDI v364, we do not have a WooCommerce web cart selection in Options/Global, which means that all possible Web Properties options are still visible, even though our sync with WooCommerce does not support them all.

    1. We do not support the following Web Properties settings for WooCommerce:

      1. Available From/To Dates

      2. New Item

      3. Last Chance

      4. Taxable

  7. Matrix Items share the same interface settings across the matrix for all WooCommerce interfaces other than Shipping Class and Tax Class, which may be set individually per Variation.

    1. As of 6/9/18, we do not normalize these shared settings across the matrix (meaning, a user could set them differently in YDI, but WooCommerce will still only support one per matrix)

    2. Our sync will push the max value of each of the shared interface settings (for example, if the setting has a numerical code and several items in the matrix have different codes for that interface, the sync will use the largest number code for the entire matrix).

  8. Tags in Yellow Dog will need to have the first letter capitalized in order to push to Woo Commerce

  9. Depending on number and size of images an extension to the timeout of the WordPress environment may be required.

Other Notes

We do support pre-existing items in WooCommerce but this may require additional setup. Your Implementation Guide will work with you.

Implementation

When generating the API Key, you will only be provided that information once. It cannot be retrieved once generated.  

>>Back to top