search-icon

The FAIRE business model is designed to give mom-and-pop shops the scale and buying terms that the 'big guys' enjoy, while helping them easily access goods from craftspeople and small manufacturers (“makers”) who make products not found in big box stores or online. FAIRE combines the buying power of thousands of mom-and-pop shops across the US to get its participating stores favorable pricing. 


FAIRE, which is four years old, now serves more than 40,000 local retailers in the United States and that number is growing rapidly. By today FAIRE has added more than 400 international artisans and vendors from 39 countries to its wholesale offerings.


This integration supports two-way (DEAR <-> FAIRE) inventory data exchange, however orders can only be created from FAIRE and captured by DEAR. 

At this time, FAIRE does not allow for forwarding shipments through third party fulfillment centers or mail forwarders.


Prerequisites

  • Apply and register account as a FAIRE brand.
    • DEAR integration is not available for FAIRE retailers
  • Provide FAIRE with relevant account owner, company and contact information. After the application is accepted, you will be provided with a FAIRE account, brand ID, API access token and personal e-shop web-page by the FAIRE onboarding team. 
  • Prepare brand store for launch on FAIREmarketplace (please contact FAIRE support for help with these steps):
    • prepare product inventory with all required properties, statuses, product variants and pricing info
    • preview the shop and make any final edits to Shop Page, Videos, Arrangement, or Shop Settings
    • activate the shop and 'Go live' on FAIRE 
  • User will need the FAIRE integration permission in order to access the integration settings and catalog. 


Table of Content


Setting up FAIRE integration in DEAR

[back to top]


As of now, FAIRE is currently available for operation in the U.S. (excluding U.S. territories), Canada (excluding Quebec), the U.K. (excluding Crown Dependencies) and the Netherlands. No orders can be created for addresses outside of these territories.


Account must be set up with:

  • Master user/account owner information
  • Company and license information
  • Configured inventory of products with all required properties
  • Configured customers
  • Credentials
  • Licenses
  • Price tiers
  • Payment terms
  • Delivery fees
  • etc.


Any number of FAIRE brands can be managed from each DEAR organisation. 


Connecting DEAR to FAIRE

[back to top]


You will need to configure some settings in FAIRE before you can integrate with DEAR. First, logon to the FAIRE account portal, and add products to your inventory. Please see FAIRE support documentation for help with this step. 


Preview the shop and make any adjustments or corrections. 


Activate the shop and go live. 


That's all from the FAIRE side. You will need your FAIRE store name and the API key (provided to you by the FAIRE onboarding team during new account registration) to connect to DEAR. Return to DEAR and log on. 

  1. Navigate to Integrations  → FAIRE.
  2. Click + to connect a new store. Any number of FAIRE brands can be managed from one DEAR organisation. 
  3. Enter your the following info:    
    • API key: Secure API authorisation key provided to you by the FAIRE onboarding team during new account registration.
  4. Now click Connect to FAIRE. You will then be taken back to DEAR.


Integration Settings

[back to top]


Once you've connected DEAR to your FAIRE store, you can then configure the integration settings between the two systems under the Setup tab on the FAIRE Integration page in DEAR.


General settings

[back to top]


Capture order when it is

DEAR can capture orders from FAIRE when:

  • Order is created
  • Order is completed (delivered in FAIRE)
  • Order is paid


Order Consolidation

Sales are processed in DEAR using any of the two consolidation types.

  • No Consolidation indicates that all walk-in/cash register sales will be created as individual sales orders in DEAR. 
  • Daily Consolidation will consolidate all sales for the day into a single sales order. 

When Daily Consolidation is chosen, a Consolidation Time setting becomes available. This is your local time when all pending orders aggregated during the day will be processed.


Customer

An existing customer in DEAR Inventory will need to be selected for pending order processing to work in certain scenarios. 

  • When Consolidation Type = Daily Consolidation, this customer is used to create a new sales task which will combine all daily sales into a single sale. 
  • When Consolidation Type = No Consolidation, this customer is used in cases where customer information is not provided. If customer info exists in the sale order, then this setting is ignored.


Wholesale Price Tier

This setting determines which DEAR product price tier to use when selling wholesale products. This is the default price tier for FAIRE products. 


Retail Price Tier

This setting determines which DEAR product price tier to use for non-wholesale product transactions. 


Pick, Pack and Ship processing mode

This setting tells DEAR if it should try to Auto Pick, Auto Pack and Auto Ship items for sale tasks created when a pending order is processed by DEAR. If there is not enough stock on hand to pick the full quantity of products in an order, then Pick should remain in "Draft" state and Pack and Ship won’t be done. 


DEAR does not pick up shipment information from FAIRE and will not create fulfillment in FAIRE if Auto-Ship is selected and will not create fulfillment in FAIRE in this case. 


Process Auto-Assembly as

This dropdown field has two options:

  • For ordered quantity: Does not check stock quantity. An assembly order is created for the quantity specified in the sale order, regardless of stock availability. 
  • For minimum quantity required for picking: Assemble stock required to meet the quantity of specific sale order. 
    • If stock availability is negative, auto-assembly will produce a finished goods quantity which is more than the quantity ordered through sale order. 
    • If there is already stock available in inventory but not enough to fulfill the sale order quantity, auto-assembly will assemble the difference in quantity needed to meet the sale order requirement.
    • If stock availability exceeds sale order quantity, auto-assembly is not triggered. 

Stock availability is validated against the sale order location and does not take On Order quantity into account.


Link FAIRE store to DEAR location 

FAIRE does not allow the use of multiple warehouses. Each FAIRE store can have a dedicated Location within DEAR which can be selected from the drop-down menu. Selecting a particular warehouse will limit the availability of stock in FAIRE to that location. The default option, All Locations, will display consolidated stock quantities across all of your locations.


Account and cash settings

[back to top]


Invoice Status

You can control the invoice status for sales tasks created as a result of pending order processing. By default, an Invoice will not be authorised and will be in Draft state, adjustable and waiting for authorisation. However, if this setting is changed to AUTHORISED, the invoice will be automatically created and authorised. It can then be synced with your preferred accounting application.


Sales Representative Name

This option allows the entered name to be used as the Sales Representative for the sales task.

 

Optional Revenue Account

The revenue account to be used for all sales downloaded from FAIRE. This will override the settings at the Product/Customer level and any other Account mapping. 


Use FAIRE as Master Source for DEAR Products

This option sets the direction of structuring data flow between DEAR and FAIRE: when enabled, DEAR should not push product families and options to FAIRE. Instead, products and families in DEAR should be updated with products, including their variant sets, from FAIRE. When disabled, FAIRE products are downloaded to DEAR only if they do not already exist there. If the FAIRE product can be matched (by SKU for single product or by family name for FAIRE variation set) to any existing DEAR product, it should be kept unchanged.


Disabled by default. 


Update Stock Levels in FAIRE

Controls if stock level is updated automatically in FAIRE store by DEAR at the time when available product quantity changes in DEAR. This may be useful for managing stock level in FAIRE. Disabled by default. 

Please ensure you have the correct stock quantities entered in DEAR before you turn on this option as these values will override the stock quantities in FAIRE.


Export shipping information to FAIRE

Enable to export shipping information from DEAR to FAIRE. Enabled by default. Please see Map Carriers section, FAIRE only allows a short, pre-determined list of carriers and if they are not mapped properly - shipping information will not be exported correctly. Only one shipment from DEAR will be exported to FAIRE and only when there are no shipments in FAIRE. (more shipments can be manually added in FAIRE)


Tax mapping

[back to top]


NOTE: Orders will be skipped on download if tax rules are not mapped! 


FAIRE transactions are not typically exposed to VAT, and in cases where they are (intra-EU, UK-EU combinations etc.) FAIRE uses intra-community supply and reverse charge rules. These will show as disclaimers on the order fulfillment page when applicable. FAIRE does not expose VAT information or any other tax information via API that DEAR can capture to its brands. For this reason, brand sales are invoiced without VAT and the retailers are assumed to handle VAT on their own. The only applicable rule to map is Tax Exempt on the DEAR side.


When a pending order is processed by DEAR, a sale task is created. Each order and invoice line is assigned a tax rule. The tax rules specified in these settings should be used to create those lines.


Map payment methods to payment accounts

[back to top]


FAIRE does not expose payment information via their API, therefore it is not possible for DEAR to automatically add payments to an invoice as with other eCommerce integrations. However, DEAR can still add an 'artificial payment' to invoices in DEAR, based on the product content of the order downloaded from FAIRE and the payment account mapping in this section. 


Payments to brands come from FAIRE, and retailers pay later. It is not possible to follow payments. 


NOTE: The artificial payment may be inaccurate (because of promo actions and discounts applied, different delivery options etc.) Users will need to check payments against FAIRE sale orders and manually correct if necessary. 


This setting is not mandatory. If payment mapping is not completed, orders are still captured and downloaded from FAIRE, but payments must be manually added to invoices in DEAR.


Disconnect from FAIRE

[back to top]


When you disconnect from your FAIRE store, DEAR removes all associations between this DEAR shop and FAIRE, including all logs and product catalog. Please take care when disconnecting from your FAIRE shop, as there is no way you can link DEAR and FAIRE again automatically without going through the initial setup operations again.


Map Carriers

[back to top]


FAIRE operates a strictly restricted list of carriers: 

  • CANADA_POST
  • DHL_ECOMMERCE
  • DHL_EXPRESS
  • FEDEX
  • PUROLATOR
  • UPS
  • USPS
  • POSTNL
  • CANPAR


These must be mapped to applicable carriers in DEAR in order for fulfilment details to map correctly. Carriers in DEAR can be added by going to Settings → Reference Book → Carriers. See Carriers for more information. 

 

From the FAIRE integration page, go to the Carrier Mappings tab to link carriers in DEAR to carriers in FAIRE. 

If multiple FAIRE stores are added into DEAR integration, a button showing Copy mappings from will be displayed, allowing you to select which store's carriers you wish to map. DEAR will not sync shipment information to FAIRE if carrier mapping has not been completed. 


Limitations

[back to top]


There are some limitations to this integration, collected here for easy review. 

  • Importing prices from FAIRE imports the USD value only. The price value of a product exported from DEAR will be  shown as USD in FAIRE.
  • Maximum unit price is $1000, FAIRE does not currently support the sale of items greater than $1000 on the marketplace. 
  • User must select a Taxonomy Type when listing a product in FAIRE.  Updates to this field are not permitted, and changes in Category will not be updated in FAIRE. Taxonomy Type will be used as Category when downloading a new product from FAIRE. Updates to this field are not permitted, and Taxonomy Type will not change category in DEAR. 
  • FAIRE products have maximum 3 options as in DEAR, but they are unchangeable after creation. Changes in options in DEAR cannot be updated in FAIRE. Option values can be updated.
  • FAIRE transactions are not typically exposed to VAT, and in cases where they are (intra-EU, UK-EU combinations etc.) FAIRE uses intra-community supply and reverse charge rules. These will show as disclaimers on the order fulfillment page when applicable. FAIRE does not expose VAT information or any other tax information via API that DEAR can capture to its brands. For this reason, brand sales are invoiced without VAT and the retailers are assumed to handle VAT on their own. 
  • Only one shipment from DEAR will be exported to FAIRE and only when there are no shipments in FAIRE. More shipments can be manually added in FAIRE.



Catalog

[back to top]


The Catalog tab on the FAIRE Integration page is where you manage products and product quantity. From the Catalog tab, you can perform the following:

  • download products from FAIRE to DEAR
  • upload a single product from DEAR to FAIRE (Use Bulk Operations to upload multiple products at at time). 
  • update (name, description, wholesale price, retail price) for individual products between DEAR and FAIRE
  • delete links between DEAR and FAIRE products
  • update stock levels in FAIRE from DEAR


Search by typing SKU, Product Name or Category into the search field. Refresh shows the most recent catalog data. 


NOTE: Customer data cannot be downloaded in bulk, however customer contact, shipping address etc. is downloaded with unconsolidated sales orders. 


Downloading Products

[back to top]


From the Catalog tab, you can download either new products from FAIRE to DEAR, upload new products from DEAR to FAIRE, or update information (name, description, wholesale price, retail price) in both directions.


NOTE: Variant names are read-only at FAIRE since they are auto-generated. Changing of names for linked products in DEAR after they have been downloaded from FAIRE is prohibited. 


In FAIRE every product must have at least one variant, because only the product variant data structure retains the SKU and pricing information. 


If the variant in FAIRE does not have any options, it can be downloaded to DEAR as a single product. If the variant has at least one option, it will be downloaded to DEAR as part of Product Family. FAIRE allows multiple options via API, and only three by its portal UI, while DEAR allows only three options for product families. Due to this, only the first three options in FAIRE should be loaded per product family in DEAR. 


DEAR only supports unique SKUs, and while FAIRE requires unique SKUs it does not check uniqueness. When downloading products from FAIRE, DEAR will skip all products with duplicated SKU or no SKU until those SKUs are corrected to be unique. 


To match FAIRE product variant sets to DEAR families the following approach is used:

  1. DEAR will search for a product family with the same name as the downloaded product. 
    1. If found, the product family in DEAR will be linked with the FAIRE product variants set. 
    2. If no matching family is found, a new family should be created in DEAR with ‘Family SKU’ formed by ID of FAIRE product, basic to its varaints. 
  2. If Products and Product Families have already been created/linked with FAIRE, then DEAR will update the existing Products and Families instead of creating new ones.
  3. IMPORTANT:Option names/values should be consistent in order between FAIRE and DEAR. E.g. if Option 1 in FAIRE is size, Option 1 in DEAR should also be size. This is because during product download DEAR will match up option names by option order, and will download all option values. 
    • If Option 1 in FAIRE is colour with values red and blue, and Option 1 in DEAR is size with options S, M, L, Option 1 after product download will have values red, blue, S, M, L. 
    • If FAIRE has options 1 and 2, but DEAR has options 1, 2, 3, after product download the product will have options 1, 2, 3. Option names will be taken from FAIRE. 
    • Values of options are not added to DEAR family if they are not mentioned explicitly in variations.
    • Removing this issue is under current development.


To download products from FAIRE to DEAR:

  1. Under the Catalog tab, click Download → Products.
  2. On the Load Products from FAIRE window, click Load from FAIRE.


Product field mapping

[back to top]


Unused fields from FAIRE are ignored. Defaults like Location, Retailer name, Currency and so on are set from settings chosen in the Setup tab. If a field does not exist in FAIRE, then null or default will be set for related DEAR field.


FAIRE only has one unit of measure, "unit". 


IMPORTANT NOTE: Option names/values should be consistent in order between FAIRE and DEAR. E.g. if Option 1 in FAIRE is size, Option 1 in DEAR should also be size. This is because during product download DEAR will match up option names by option order, and will download all option values. 

  • If Option 1 in FAIRE is colour with values red and blue, and Option 1 in DEAR is size with options S, M, L, Option 1 after product download will have values red, blue, S, M, L. 
  • If FAIRE has options 1 and 2, but DEAR has options 1, 2, 3, after product download the product will have options 1, 2, 3. Option names will be taken from FAIRE. 
  • Values of options are not added to DEAR family if they are not mentioned explicitly in variations.
  • Removing this issue is under current development. 


DEAR fieldFAIRE field
Simple products (FAIRE product has just one variant and options of product is not empty)
SKUvariants[0].sku
Product Namename
Short Descriptionshort_description (max 75 characters)
Descriptiondescription (max 1000 characters)
Category*taxonomy_type.name
Brandbrand_id
QuantityQuantity
Price Tier value for Retail priceRetail price in USD**
Price Tier value for Wholesale priceWholesale price in USD**
Imagesimages
Family product (FAIRE product has at least one option_set in options)
SKUid
Product Namename
Short Descriptionshort_description (max 75 characters)
Descriptiondescription (max 1000 characters)
Category*taxonomy_type.name
Brandbrand_id
QuantityQuantity
Price Tier value for Retail priceRetail price in USD**
Price Tier value for Wholesale priceWholesale price in USD**
Imagesimages
Option Name (1-3)***variant_option_sets[].name
Option Value (1-3)variant_option_sets[].values
Variation of family product
SKUsku
Product Namename + variant_option_sets[i].name + variants[].options[i].value
Short Descriptionshort_description (max 75 characters)
Descriptiondescription (max 1000 characters)
Category*taxonomy_type.name
Brandbrand_id
QuantityQuantity
Price Tier value for Retail priceRetail price in USD**
Price Tier value for Wholesale priceWholesale price in USD**
Imagesvariants[].images
Option Name (1-3)***variants[].options[].name
Option Value (1-3)variants[].options[].value

*User must select a Taxonomy Type when listing a product in FAIRE, and Taxonomy Type will be used as Category when downloading a new product from FAIRE. Updates to this field are not permitted. 

**FAIRE does not currently support the sale of items > $1,000 on the marketplace.

***FAIRE products have maximum 3 options as in DEAR, but they are unchangeable after creation. Changes in options in DEAR cannot be updated in FAIRE. Option values can be updated.


Updating Quantities

[back to top]


To update product quantities in FAIRE with the currently available quantities in DEAR:

  1. Under the Catalog tab, click Update Quantities in Faire.


Managing the Catalog

[back to top]


List a product in FAIRE

[back to top]


  1. Click on the product in the Catalog tab. 
  2. Enable or disable Sync Stock Level for that product. Disabling means stock levels will NOT synchronise for that product when there is a change in its stock level in DEAR.
  3. Select a Taxonomy Type for the new product. Taxonomy Types are downloaded from FAIRE. Taxonomy is used only once to classify the product in FAIRE on-site catalog and is not related to DEAR category at all, except the case when new product is created at DEAR side upon download from FAIRE - when DEAR category is fulfilled with FAIRE taxonomy type.
  4. In the pop-up window, click List on FAIRE.
  5. Save your changes.


Update a product

[back to top]


  1. Click on the product in the Catalog tab. 
  2. Enable or disable Sync Stock Level for that product. Disabling means stock levels will NOT synchronise for that product when there is a change in its stock level in DEAR.
  3. In the pop-up window, click Update on FAIRE.
  4. Save your changes.


NOTE: Updating a product from the catalog will update stock level in FAIRE, regardless of the sync stock level setting status.


[back to top]

  1. Click on the product in the Catalog tab. 
  2. Click Unlink from FAIRE.
  3. Click Save.


This will unlink the product in DEAR from FAIRE, but not remove it from FAIRE.


Remove a product

[back to top]

  1. Click on the product in the Catalog tab. 
  2. Click Remove from FAIRE.
  3. Click Save.


This will remove the product from FAIRE (but not in DEAR).



Bulk Operations

[back to top]


On this tab, you can manage DEAR products listing on FAIRE in bulk. 

Products can be updated, unlinked (breaks link without removing product from FAIRE) or unlisted (sets FAIRE product to Archived) from this tab. Press Refresh to update the display. 

  1. Go to the Bulk Listing tab.
  2. Select products to list, update, unlist, or unlink in bulk. You can select products by Brand, Category, Product Tag. 
  3. (new listing in FAIRE only) select a Taxonomy Type from the dropdown field. This will be applied to all items in the bulk listing. Taxonomy types will be loaded from FAIRE.This is ignored for updating of existing items. 
  4. Click List/Unlist/Unlink to carry out the bulk operation. If products are already listed, pressing list will update the product.


Pending Orders

[back to top]


Newly created orders or orders where status have changed are downloaded once an hour. Generally, you are not required to trigger manual order download. However, if an order was not captured by DEAR or to load historical sales, you can use the Manual Order Download option available from the Pending Orders tab. DEAR allows loading historical sales data a maximum of one year old.


Whenever a sale is captured from FAIRE, it is first place into Pending Orders and stock is allocated. The pending orders list can be searched by order #, product, and customer fields. DEAR should import new orders with Processing status. If No Consolidation is selected, each FAIRE sale is converted into an identical sale in DEAR, keeping the same customer and shipping information. If Daily Consolidation is selected, a single daily sale task will be created and use the customer selected in the Integration Settings for store, so that customer, billing, and shipping information from FAIRE should be ignored.


When a FAIRE order is cancelled, DEAR has to automatically find and void the corresponding sale task, if created, or remove the associated pending order - if the order has not been processed yet. Cancellation in FAIRE will not cancel the relevant part of a consolidated order, which will have to be cancelled and voided manually.


Loading Pending Orders from FAIRE

[back to top]


To download pending orders manually:

  1. Select the Pending Orders tab.
  2. Click Load Orders.
  3. On the Load Orders from FAIRE window, select a date for the sales transactions to be loaded from the calendar, then click Load from FAIRE. DEAR allows loading historical sales data a maximum of one year old.


Take note of the following when loading pending orders from FAIRE:

  • Any downloaded order is saved to Pending Sales, which is a temporary storage of all sales and payments in DEAR. Only orders matching the defined capture option are saved.
  • If an order has an entry in Logs, or if it was already downloaded before, it will be skipped. This guarantees that DEAR will not create any duplicate sales from previous transactions.
  • While saving an order, DEAR captures customer information, billing and shipping addresses. All line items are captured together with quantities, prices and totals. Total order discounts are applied as additional charges to the whole order, without distribution by lines to reduce any chances of discrepancy.
  • For each line in a Sale, DEAR attempts to locate the corresponding product by SKU. If no product is found, DEAR attempts to download product info from FAIRE with the same logic as in the Download Products function. The sale line is then saved to Pending Orders with all data from FAIRE, including Tax, Quantity and Total.


Processing Pending Orders

[back to top]


After pending sales orders are reloaded from FAIRE, you should process pending orders to generate sales in DEAR.


To manually process pending orders, click Process on the Pending Order tab. Order download includes download of  all lines, customer first/last name and company name. No payments are downloaded. 


When a FAIRE order is cancelled, DEAR has to automatically find and void the corresponding sale task, if created, or remove the associated pending order - if the order has not been processed yet. Cancellation in FAIRE will not cancel the relevant part of a consolidated order, which will have to be cancelled and voided manually.


In FAIRE discounts applied will be captured as a negative charge in DEAR.


Refunds

[back to top]


Returns and refunds are not yet supported in this integration. 


Order field mapping

[back to top]


Billing and Shipping details are not differentiated in FAIRE API, so will take the same values. 


DEAR field
FAIRE field
OrderIDID
OrderNumberDisplayID
CustomerNameRetailerID (or default customer from setup)
ShippingContactCompanyRetailerID (or default customer from setup)
ShippingContactNamecustomer.first_name + customer.last_name (or default customer from setup)
FinancialStatus , OrderStateState
SalesRepresentativefrom settings in DEAR
LocationIDfrom settings in DEAR
ShippingRequiredByDateShip_after
ShippingContactPhoneaddress.phone_number
CustomerShippingProvinceaddress.state
CustomerShippingCountryaddress.country
CustomerShippingAddressLine1address.address1
CustomerShippingAddressLine2address.address2
CustomerShippingZipaddress.postal_code
CustomerShippingCityaddress.city
Payments(payment_initiated_at) exists
Payments[0].Date
Payments[0].AmountTaken artificially as full amount paid if field mentioned
Discount (sale lines)

    

(brand_discounts) (calculated amount)


Shipment (sale lines)(maker_cost_cents) exists
Shipment[0].Price, TotalPerLinemaker_cost_cents / 100


Log

[back to top]


Each captured FAIRE order, once saved to Pending Sales, creates a Log entry to enable tracking of the linked sale in DEAR and in FAIRE. This also helps avoid creating duplicate orders when capturing the same order several times during manual order load.


Each Log entry must have a link to the sale task in DEAR. Depending on the settings selected by the user in the Setup tab, this sales task might be in Draft or Authorised status, one or more of the Pick, Pack and Ship tabs could be authorised, and payment could have been applied to the invoice.


To view Log entries, select the Log tab.

Take note of the following considerations when it comes to Log entries:

  • They allow you to see which sales task links to a particular FAIRE sale. 
  • You have an option to delete Log entries manually. This will allow you to reprocess an order if required. Deleting log entries will not void or delete sales tasks associated with these entries.


Operations Log

[back to top]


All operations that affect FAIRE integrations are reflected here. Each time the user or DEAR downloads sales or makes changes to the integration settings or catalog, the appropriate record is added to the operations log, which also contains information about results of downloading, including the count of processed, skipped or cancelled orders. Non-administrative users can only see activities in the modules/categories to which they have access.




Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.