BigCommerce Interface
Last Updated 2/16/2022
Overview
The 2-Way integration with BigCommerce pushes items, pulls codes and pulls sales from Big Commerce’s API.
With our two-way interface, Yellow Dog utilizes BigCommerce's API to pull Codes (Categories and Tax Classes), push items and process orders.
Sync Apporoach
The integration contains two elements:
SyncYDIWithMicroServices to pull codes (Categories and Tax Classes) and push items
SyncYDIWithBigCommerce to pull sales
Sync Frequency
This syncs can be scheduled to run at any interval.
This syncs may be run from any location with internet access.
Configuration
For brand new integrations, a pull will need to be ran first to populate Categories and Tax Classes in yellow Dog.
The following will need to be determine in order to properly configure the sync:
Number of Categories used
If push cost will be used
If push on hand (store only) will be used
If push on hand (all stores combined) will be used
Requirements
BigCommerce Back Office Requirements
The following will need to be configured in BigCommerce:
API Credentials for Yellow Dog Inventory (Implementation Guide can provide instructions). Yellow Dog will need:
ClientID
Client Scret
Access Token
OAth Scopes
Orders “Read Only”
Information & Settings “Read Only”
Products “Modify
Data Exchange
Yellow Dog will push the following item details to Big Commerce when the following is true:
Send To Web enabled
Available to the Store being synced
Active
Not Removed
At least one Big Commerce Category assigned
Big Commerce Field | Yellow Dog Field |
---|---|
Name | Matrix Web Title/Item Web Title/Item Description |
Description | Matrix/Item Web Extended Descripiton |
SKU | SKU |
Type | Default= Physical |
Is Visible | True when WebItem.Available=1, Item2Store.Available=1, Item.RowDeleted=0, and Item.Active=1; if any of these are not true, then "Disabled" |
Available vs Disabled | Available when WebItem.Available=1, Item2Store.Available=1, Item.RowDeleted=0, and Item.Active=1; if any of these are not true, then "Disabled" |
Sale Price | WebItem.ItemSaleRetail or |
Price | Retail1 |
Inventory_Tracking | Turned on when "Push On Hand" is enabled, for matrix item this is "Variant" and for single items this is "Product" |
Inventory_Level | On Hand (can be set per store or combined for all stores) |
Cost_Price | Default Vendor Price |
Weight | Shipping Weight |
Width | Shipping Width |
Height | Shipping Height |
Depth | Shipping Length |
Image | Image URL (Requires YDI v 366+ with all items having been pushed to S3) |
UPC | UPC 1 - limit one per item |
Options 1-3 | Dimensions for Matrix Items |
Option Type 1-3 | Dimesnions for Matrix items |
Categories | Big Commerce Categories |
Tax Class | Big Commerce Tax Class |
Limitations
Multiple Big Commerce instances against a single Yellow Dog Database is not currently supported.
Requires YDI v366+ for pushing Images because it uses Image URL.
All Matrix items must share the same Web Item Title, Web Item Description, Categories and Tax Class.
We push Shipping Dimensions correctly, but it should be noted that our Length = their Depth.
If an item is deleted in BigCommerce, Yellow Dog will continue trying to push and cause errors.
Additional Information
Yellow Dog's sync with BigCommerce is programmed to work with the BigCommerce API v2 and that version has been hard coded into the API path that we use in this sync. If the API version has changed, this sync will not work.