Quick Start Integration Guide

Table of Contents 

  1. Introduction
  2. Creating a FarApp Account
  3. Setting Up Your Storefront
  4. Setting Up NetSuite
    1. Preparing NetSuite to Connect to FarApp
    2. Installing the FarApp Bundle on NetSuite
    3. Creating Subtabs for the Item Creation Screen
    4. Installing the FarApp Marketplace/Cart - Item Fields Bundle on NetSuite
    5. Creating the Product Sync Fields Using the FarApp Marketplace/Cart - Item Fields Bundle
    6. Configuring NetSuite to Allow You To View Field ID's and Internal ID's
  5. Setting Up FarApp
    1. Connecting FarApp to NetSuite
    2. Connecting FarApp to Your Storefront
    3. Setting Up Order Sync and Fulfillment Sync for Your Storefront
      1. Custom Transaction Body Fields
      2. Mapping the SKU Field
      3. Confirming Your Price Level
      4. Importing Your First Order
      5. Updating Your First Order
      6. Setting Up Order Sync
      7. Enabling Order Sync and Fulfillment Sync
    4. Setting Up Product Sync for Your Order Sync
      1. Storefront Flag Field
      2. Creating a Test Product in NetSuite
      3. Retrieving a Test Product Into FarApp and Posting it to a Storefront
      4. Enabling Product or Price/Qty Sync
    5. Setting Up Refund Sync for Your Storefront
    6. Setting Up Your Notification Settings
  6. Connecting FarApp to Your 3PL's
  7. Custom/Bespoke Connectors
  8. Other Connectors
  9. Credit Cards and PCI Compliance
  10. Next Steps and Additional Information

 

Introduction

Welcome, and thank you for choosing FarApp. To get started with your FarApp integration, please follow the steps below. Not all of our customers follow all of the steps, however, because not all of ours customers will need to connect the same things (i.e. if you do not want to connect a 3PL such as ShipWorks, please skip that portion).

The following article provides a generalized overview of integrating with FarApp. We are also working on providing storefront-specific instructions that will provide more detailed instructions specific to each storefront. We will link these articles here as they become available. They can also be found in the sections of our Knowledge Base devoted to that storefront.

SuiteSuccess Connectors:

  1. Amazon Integration Guide: https://support.farapp.com/hc/en-us/articles/230497688-Amazon-Integration-Guide
  2. Magento Integration Guide: https://support.farapp.com/hc/en-us/articles/231832627-Magento-Integration-Guide
  3. Shopify Integration Guide: https://support.farapp.com/hc/en-us/articles/229257827-Shopify-Integration-Guide
  4. eBay Integration Guide: https://support.farapp.com/hc/en-us/articles/115006636527-eBay-Integration-Guide

Additional Storefront Connectors:

  1. BigCommerce Integration Guide: https://support.farapp.com/hc/en-us/articles/115006978968-BigCommerce-Integration-Guide
  2. Jet Integration Guide: https://support.farapp.com/hc/en-us/articles/115011641527-Jet-Integration-Guide
  3. Magento2 Integration Guide: https://support.farapp.com/hc/en-us/articles/115011514868-Magento2-Integration-Guide
  4. Miva Integration Guide: https://support.farapp.com/hc/en-us/articles/115011647887-Miva-Integration-Guide
  5. Newegg Integration Guide: https://support.farapp.com/hc/en-us/articles/115011871048-Newegg-Integration-Guide
  6. Walmart Integration Guide: https://support.farapp.com/hc/en-us/articles/115011479028-Walmart-Integration-Guide
  7. WooCommerce Integration Guide: https://support.farapp.com/hc/en-us/articles/115007401268-WooCommerce-Integration-Guide

3PL Connectors:

  1. ShipStation Integration Guide: https://support.farapp.com/hc/en-us/articles/115011334208-ShipStation-Integration-Guide
  2. ShipWorks Integration Guide: https://support.farapp.com/hc/en-us/articles/115011371928-ShipWorks-Integration-Guide
  3. Shipwire Integration Guide: https://support.farapp.com/hc/en-us/articles/115011378588-Shipwire-Integration-Guide
  4. ShippingEasy Integration Guide: https://support.farapp.com/hc/en-us/articles/115011373528-ShippingEasy-Integration-Guide

We provide a number of support plans for our customers to best meet the needs of their businesses. You can read more about each plan here: https://support.farapp.com/hc/en-us/articles/222413588-Support-Tiers For customers in the Managed/Priority or Enterprise Integration or Ongoing plans, if you would like to not go through the steps in this article, or if you would like assistance going through it, please open a ticket with us and we will be able to assist you. If you are not part of either of these plans, but would like to sign up for one, please contact us and we will set you up with your desired plan.

 

Creating a FarApp Account

  1. Navigate to http://www.farapp.com/
  2. Click "Sign Up"
  3. On the new screen, populate the required fields and agree to the Subscription.
  4. Click "Submit"-
  5. Check your inbox for an email from FarApp at the email address you entered in step 3 and follow the link provided in the email to activate your FarApp subscription at http://www.app.farapp.com/dashboard.

 

Setting Up Your Storefront

This article assumes that you have already configured your storefront and are familiar with navigating it, posting products on it and taking orders through it.

It may be possible to set up items in your storefront without SKU's. Please make sure your items have SKU's. FarApp will use the SKU of each item to match it with its corresponding item in NetSuite.

If you have any third party applications/scripts/extensions already installed on your storefront that you believe might affect how items post or update or how orders are formatted, please contact us and let us know the details of these third party applications. Anything that effects the data on items or orders has the potential to effect FarApp's ability to sync your items or orders.

 

Setting Up NetSuite

This article also assumes that you have already created a NetSuite account and are familiar with creating Items, Sales Order/Cash Sales and the accounting processes you will be using.

FarApp provides two different authentication methods to allow integration with your NetSuite account. FarApp and NetSuite recommend using the token-based authentication (TBA) method. This method is the most secure, easiest to maintain and most stable. It also reduces the likelihood of timeout and credential errors.

Please see this article for instructions for updating your NetSuite account and FarApp integration to use the token-based authentication method: https://support.farapp.com/hc/en-us/articles/115013718667-NetSuite-Token-Based-Authentication. You will complete the NetSuite Setup portion now and the FarApp Setup portion later.

If you prefer to not use token-based authentication, please follow the steps below.

Preparing NetSuite to Connect to FarApp

  1. Log in to NetSuite as an administrator.
  2. Navigate to Setup > Company > Enable Features.
  3. Select the SuiteCloud tab.
  4. In the section SuiteTalk (Web Services), make sure the Web Services checkbox is checked. If not, check the box, and save your settings.
  5. Navigate to Setup > Integration > Web Services Preferences.
  6. Copy Account Number for use below.
  7. Navigate to Setup > Integration > Web Services Preferences.
  8. In the upcoming steps you will be giving FarApp access to your NetSuite. You can choose to assign the user you give FarApp an the administrator role—usually internal ID 3. (You can find your current user rule ID following that steps at https://support.farapp.com/hc/en-us/articles/115014364008-How-to-Find-Your-NetSuite-Role-ID.) If you do not want to give the FarApp user the administrator role, you will need to make sure that the FarApp user has the following permissions:
  • Lists > Accounts Full
  • Lists > Customers Full
  • Lists > Items Full
  • Lists > Locations View
  • Lists > Payment Methods View
  • Lists > Documents and Files Full
  • Transactions > Sales Order Full
  • Transactions > Sales Order Approval Full
  • Transactions > Find Transaction Full
  • Transactions > Item Fulfillment View
  • Setup > Web Services Full
  • Setup > Accounting Lists View
  • Setup > Custom Item Fields View
  • Setup > Custom Transaction Fields Full
  • Setup > Custom Fields Full
  • Setup > Custom Lists Full
  • Setup > Custom Record Types Full
  • Setup > Other Custom Fields View
  • Setup > Other Lists View
  • Setup > Custom Body Fields Full
  • Lists > Currency View
  • Lists > Shipping Items
  • Transactions > Invoice View
  • Transactions > Fulfill Sales Orders View
  • Transactions > Credit Memos
  • Transactions > Fulfill Sales Orders Full (for 3PL integrations only)

Installing the FarApp Bundle on NetSuite

FarApp's NetSuite bundle (just called FarApp for simplicity) is used to push item updates to FarApp from NetSuite in real-time to improve update speeds. If FarApp is doing product and/or inventory updates, you should install the bundle. You can read more about using the FarApp bundle here: https://support.farapp.com/hc/en-us/articles/219375948-FarApp-NetSuite-Bundle

*Please note, if you don't enter your FarApp credentials (the credentials you use to log into FarApp) in the two separate locations mentioned in the section below, you will get invalid credentials errors in NetSuite after installing the bundle. This will prevent you from creating transactions in NetSuite until the credentials are entered.

*Please be sure to only install the FarApp bundle on the account you currently have connected to FarApp here: https://app.farapp.com/settings#/netsuite_settings (e.g. if you have both a NetSuite sandbox and live NetSuite, please ensure you only install it on one of these at a time)

To install the bundle, follow these steps in NetSuite. Once started, you must complete them:

  1. Make sure you are logged in to NetSuite as an admin user.
  2. Go to Customization->SuiteBundler->Search & Install Bundles.
  3. Enter FarApp in the KEYWORDS box and click the Search button.
  4. Find the result named just "FarApp" and click on the name.
  5. Click Install. It may take a little time but this will install the bundle.
  6. Once installation completes, go to Customization -> Scripting -> Script Deployments
  7. From the Drop down that says 'Scripts' select 'Push Item Updates to FarApp'
  8. Click 'Edit' on the deployment that shows up in the list
  9. Click the 'Parameters' tab and enter your FarApp credentials (i.e. the ones you use to login to app.farapp.com) in the text fields
  10. Click 'Save'
  11. Go to Setup->Company->General Preferences.
  12. Go to the Custom Preferences tab.
  13. In the FarApp section, enter your FarApp credentials (i.e. the ones you use to login to app.farapp.com).
  14. If you have user-event scripts in NetSuite that modify an item record as you save the item record (for example, upon save, it auto-computes the prices and updates them), then check the "HAVE ITEM-MODIFYING USER-EVENT SCRIPTS" box. Otherwise, leave it unchecked for improved performance.

Once the above is done, any item and/or inventory changes will be pushed to FarApp in real-time.

Creating Subtabs for the Item Creation Screen

When you create an item in NetSuite, you will need to populate a number of fields with information like the item's description, weight, color, etc. NetSuite organizes these fields within subtabs. FarApp requires several unique fields in order to sync your items from NetSuite to your storefronts automatically. These steps will walk you through creating special subtabs for these fields. Our images in these steps are using Amazon just as an example.

  1. Make sure you are logged into your NetSuite account.
  2. Navigate to "Customization" > "Forms" > "Subtabs".
  3. Navigate to the “Item” tab.
  4. Fill out the following (without the quotes) in the title field: “Marketplace/Cart". Click "Save".
  5. Navigate back to "Customization" > "Forms" > "Subtabs".
  6. Navigate to “Item” tab.
  7. Fill out the following two entries (without the quotes) in the title fields: “Optional” and “Required”. Make the Parent "Marketplace/Cart" for both entries. Save.
  8. Navigate back to "Customization" > "Forms" > "Subtabs".
  9. Navigate back to “Item” tab.
  10. Fill out the following (without the quotes) in the title field: “Amazon" [or "Shopify", "Magento", etc. as appropriate]. Click "Save".
  11. Navigate back to "Customization" > "Forms" > "Subtabs".
  12. Navigate to “Item” tab.
  13. Fill out the following three entries (without the quotes) in the title fields: “Not Common”, “Optional”, and “Required”. Make the Parent "BigCommerce" for each entry. Save.
  14. Navigate back to "Customization" > "Forms" > "Subtabs".
  15. Once you are finished, your Custom Subtabs should look like this (but for with the appropriate storefront name if not Amazon):Screen_Shot_2017-04-26_at_1.50.56_PM.png
  16. Please note that if you name something incorrectly, once you install and run the FarApp Marketplace/Cart - Item Fields bundle (coming up in the next section), the bundle will provide feedback on what tab or subtab you need to return to and recreate.

Installing the FarApp Marketplace/Cart - Item Fields Bundle on NetSuite

*The FarApp Marketplace/Cart Item Fields Bundle currently only creates fields for BigCommerce, Shopify, Magento, eBay and Amazon. If you are integrating a different marketplace or cart, you should skip this section.

**Please note that if you are installing the FarApp Marketplace/Cart - Item Fields Bundle on NetSuite you need to have completed the steps above for "Creating Subtabs for the Item Creation Screen."

  1. The FarApp Marketplace/Cart - Item Fields Bundle will automatically create the basic item fields that FarApp will require. To being installing the bundle, login to your NetSuite account.
  2. Navigate to Customization > SuiteBundler > Search & Install Bundles
  3. Enter "FarApp Marketplace/Cart - Item Fields" in the "KEYWORDS" field and Click "Search"Screen_Shot_2017-05-09_at_11.14.01_AM.png
  4. Select "FarApp Marketplace/Cart - Item Fields"
  5. Click "Install"
  6. Click "Install Bundle", then Click "Ok"
  7. This will redirect you to the list of your installed bundles. You will see the first in the list as “Loading”. After allowing some time, click Refresh and confirm you see “FarApp Marketplace/Cart - Item Fields”

Creating the Product Sync Fields Using the FarApp Marketplace/Cart - Item Fields Bundle

*The FarApp Marketplace/Cart Item Fields Bundle currently only creates fields for BigCommerce, Shopify, Magento, eBay and Amazon. If you are integrating a different marketplace or cart, you will need to create the NetSuite fields you would like to use manually. Some customers use only pre-existing NetSuite fields. Other create custom fields to meet their needs.

  1. Next, please navigate to Setup > FarApp > Marketplace/Cart Fields.Screen_Shot_2017-05-09_at_11.18.21_AM.png
  2. Here, please select the Marketplace/Cart you will be integrating with and then enter in the number of accounts you plan to set up with FarApp for that Marketplace/Cart. You can do this multiple times if you have multiple Marketplaces/Carts that you want to integrate.Screen_Shot_2017-03-13_at_2.49.19_PM.png

Configuring NetSuite to Allow You To View Field ID's and Internal ID's

  1. Go to Setup > Company > Enable Features > SuiteCloud and check the box for Client SuiteScript if it hasn’t already been checked.
  2. Go to Home > Set Preferences > General Tab > Set Defaults and check the box for Show Internal IDs if it hasn’t already been checked.
  3. For additional information on this, please reference this article: https://support.farapp.com/hc/en-us/articles/216635418-NetSuite-Internal-IDs-and-Field-IDs

 

Setting Up FarApp

If you’re using NetSuite as your backend, you will need to connect FarApp to your NetSuite account in the following sections. FarApp also offers a SkuVault connector. It you would like to integrate with SkuVault instead on NetSuite, please open a ticket with us and we will provide you steps for integrating with SkuVault.

Connecting FarApp to NetSuite

If you enabled token-based authentication on your NetSuite account above, please skip this section and complete the steps in the FarApp Setup section at https://support.farapp.com/hc/en-us/articles/115013718667-NetSuite-Token-Based-Authentication. If you did not enable token-based authentication, please follow the steps below.

  1. To get started, login at https://app.farapp.com/dashboard. This page will be the hub for your activity within FarApp, allowing you to setup and manage accounts, as well as test and oversee order processing. After this, please follow the steps below. Not all of our customers follow all of the steps, however, because not all of ours customers will need to connect the same things (i.e. if you do not want to connect a 3PL such as ShipWorks, please skip that portion).
  2. A popup window will prompt you to choose your Master System. You will be using NetSuite as your Master System.
  3. Click ‘Edit’ for the NetSuite connector, and enter your NetSuite account information. Please note that you can add multiple NetSuite logins on this page. Unless you have a SuiteCloud Plus license, most NetSuite accounts only allow a single concurrent session to NetSuite. If you process a large number of transactions (1,000+/day) or have a lot of SKUs (50,000+), it may benefit you to enter more than one NetSuite login. If you have SuiteCloud Plus, please let us know so that we can configure your account to take advantage of multiple concurrent sessions.
  4. Enter your Account Number that you made a note of above.
  5. Make sure to check the "Active" box for any additional logins that you want FarApp to use. If you want to deactivate one of these additional logins so that FarApp doesn’t use the login, you can either uncheck the box in the “Login Active” column or delete the row.
  6. Enter the email for the user you want to assign to FarApp. This is the email account with which you log into NetSuite. It can be an account dedicated to FarApp (e.g. farapp@yourdomain.com) or it can be one of your existing accounts. FarApp uses web services to communicate with NetSuite. Since web services sessions don’t conflict with interactive sessions, you can be logged into NetSuite at the same time as FarApp. The only benefit to providing FarApp its own credentials is if you want to control permissions separately for FarApp and/or if you want to be able to view the history of changes made by each user in NetSuite. If you do decide to provide FarApp its own unique login, please use your own domain (e.g. farapp@yourdomain.com) and not the “farapp.com” domain.
  7. Enter the password associated with this NetSuite account.
  8. Assign the user the internal ID of the NetSuite role you want to assign to this email. If you are not going to assign a role, please make sure the FarApp user has the permissions listed in the section above.
  9. Once you populate the information above, please click “Save Settings”. This will save the settings in FarApp and test them to make sure that FarApp can properly log into NetSuite.
  10. If the NetSuite account you are connecting FarApp to is a sandbox account, please go to https://app.farapp.com/dashboard, click on the the gear icon at the top right, select Settings and go to the NetSuite Settings Page in the left panel. Flag the first checkbox on that page for "The NetSuite account you're connecting is a sandbox account and not a production account." 

Connecting FarApp to Your Storefront

  1. Return to https://app.farapp.com/dashboard.
  2. If the pop up window for adding a connector is not already present click the "Add New Connector" button at the bottom of the page.
  3. In the pop up window, click the logo for the storefront you would like to connect to. You will be prompted to select an integration support plan. You can read more about out integration support plans at https://support.farapp.com/hc/en-us/articles/115009555447-Customer-Success. Finally, enter a name and nickname for the new account.

Setting Up Order Sync and Fulfillment Sync for Your Storefront

After connecting their marketplaces/carts, most customers test and setup order sync for their storefront. Posting a test order, however, will require that you have products you can purchase. If you don't, move on to product sync first in the next section and then return to this step.

*Important! Before you attempt to import an order using FarApp, make sure you can import an order manually with NetSuite. Any field that you cannot import manually FarApp will be unable to import as well.

In order to get order sync setup you will need to make sure that you can successfully import a test order into NetSuite. The first step to this process is getting your account setup to import a test order. There are two parts to this step: getting the custom transaction body fields FarApp requires setup, and mapping the SKU field to your orders. First we'll look at how to setup the mapping to your custom transaction body fields, then we'll take a look at setting up the mapping for your SKU field.

Custom Transaction Body Fields

FarApp requires two transaction body fields for order processing. We use these fields to ensure that duplicate orders do not get posted to your NetSuite account. Please note that if you followed the steps above for installing the FarApp for SuiteSucess bundle, these fields are automatically created for you. If you would like to manually create your own fields, or did not install the FarApp for SuiteSucess bundle, here are instructions on how to create these fields in NetSuite: https://support.farapp.com/hc/en-us/articles/217181157-Setting-Up-FarApp-s-Required-Custom-Transaction-Body-Fields

To get your custom transaction body fields setup in FarApp follow these steps:

  1. Click the gear icon in the top right corner of the screen, then click “Settings.”
  2. Click “NetSuite Settings” on the menu bar that appears on the left hand side of the screen. You should now see the mapping screen. 
  3. You should see two text boxes on the screen, one that says “Custom transaction body storefront field” and another that says “Custom transaction body storefront order field” (If you do not, then it means you setup multiple connectors and will want to make sure that both the “Channel” and “Account” drop downs are set to “All”).
  4. Input the Field IDs for both of these fields (including the custbody portion). If you are unsure how to get the Field IDs follow the instructions here to get them: https://support.farapp.com/hc/en-us/articles/216635418-NetSuite-Internal-IDs-and-Field-IDs
  5. Click “Save” at the bottom of the screen. You are now ready to import your first order.

Mapping the SKU Field

The SKU Field is the field that FarApp uses to link up the line items on your orders with their corresponding items in NetSuite. In order to properly match up the items, FarApp needs to know what field in NetSuite you use as your SKU field. To get your SKU field mapped, follow these steps:

  1. Navigate to the General Settings for your MarketPlace/Cart by clicking the gear icon in the top right, clicking "Settings", selecting "Marketplace/Cart Settings" (if you have only one Marketplace, instead of Marketplace/Cart it will say the name of the Marketplace, ex: "Magento Settings"), and then selecting General Settings (direct link is https://app.farapp.com/settings#/marketplace_cart_settings/general_settings).
  2. If you have multiple channels/accounts, make sure you select the appropriate ones from the dropdowns that appear at the top. On this page you will see a text field labeled "NetSuite SKU Field" as shown here:
  3. In NetSuite, find the field ID of the field that you use as your SKU field and enter it into the text field (e.g. itemId for Item/Name Number), then click "Save" at the bottom of the page.

Confirming Your Price Level

You can control your price levels in NetSuite. They determine what prices are offered on your items in different situations (you may make items more expensive in store versus online). When FarApp syncs orders to NetSuite, NetSuite requires that we select a price level on the items on the order. FarApp recommends that you ALWAYS use the "Custom (IID:-1)" price level. This means that FarApp will post the exact price your storefront charged to the line-item in NetSuite. This allows for offering discounting and prevents situations where NetSuite thinks the item cost a different amount than what you actually charged the customer.

FarApp sets your price level mapping to "Custom (IID:-1)" by default for all new connectors, but these steps will have you confirm this.

  1. Navigate to the Order Item Mapping tab for your MarketPlace/Cart by clicking the gear icon in the top right, clicking "Settings", selecting "Marketplace/Cart Settings" (if you have only one Marketplace, instead of Marketplace/Cart it will say the name of the Marketplace, ex: "Shopify Settings"), selecting Order Settings and then selecting the Order Item Mapping tab (direct link is https://app.farapp.com/settings#/marketplace_cart_settings/order_sync/order_line_mapping).
  2. If you have multiple channels/accounts, make sure you select the appropriate ones from the dropdown menus that appear at the top.
  3. Confirm that a mapping for Price Level exists and that its value is Custom (IID: -1).Screen_Shot_2017-10-25_at_3.15.15_PM.png
  4. If the mapping does not exist, click "Add Mapping Row" and re-create the mapping in the picture above. Click Save when done.

Importing Your First Order

Now that you have setup the required order fields, let’s try importing an order.

  1. Click the “Orders” tab at the top of your screen. This will take you to the orders screen which will show you all the orders you have imported through FarApp.
  2. On the right side of the blue menu bar, you will see a gear icon; hover over this icon and select “Retrieve Order.”
  3. Fill in the correct Channel, Account, and Order ID, and select “Retrieve”. You should see the order appear in FarApp.
  4. Now that the order has appeared, you can try posting it to NetSuite. To the right of the order, click the pen-and-paper button and select “Post Order to NetSuite.”
  5. In a few moments (you may need to refresh the page), you will either see the order turn green to indicate the order posted successfully, red to indicate that there was a posting error, or grey with a status of "complete" to indicate the order has posted as a Cash Sale to NetSuite and no fulfillment is required. If you retrieved an FBA order, its status should be "complete" once posted.
  6. If the order turns red, you have a posting error. Hover over the order to see the error; many errors can be resolved by updating your mappings. Since this is your first order two errors you will have to fix are that the shipment and payment methods are not mapped. If the order is an FBA order, you will need to set up your shipment method mapping here https://app.farapp.com/settings#/marketplace_cart_settings/order_sync/shipment_settings in the "Default shipment method to use for FBA orders:" field and your payment method mapping here https://app.farapp.com/settings#/marketplace_cart_settings/order_sync/payment_settings in the "Payment method for Amazon-fulfilled (FBA) Amazon orders:" field. If it is an MFN order, however, here are the links to instructions for setting these mappings up on your own:
  7. Since NetSuite does not report all errors with an order at once you may find yourself clearing up one error to see a new one appear. This is the normal process to follow when importing an order.
  8. Once you have cleared all the errors and the order is showing as green check the order in NetSuite to confirm that all your desired data is in NetSuite.
  9. If there are fields missing in the NetSuite order you’ll want to follow the steps in the “Updating Your First NetSuite Order” section.
  10. If all the fields are present, congrats! You have successfully pulled in a NetSuite order using FarApp. Continue to the “Setting Up Order Sync” so we can start automatically pulling in your orders.

Updating Your First Order

Since you are missing some fields in your NetSuite order you’ll need to add some more mappings. Repeat step 6.3 of “Importing Your First Order” until you have mappings for all the fields you want. Once that is done follow these steps to update your order in NetSuite:

  1. Click the “Orders” tab from the menu at the top of the page.
  2. Click the pen-and-paper icon to the right of your test order.
  3. Click “Update Order In NetSuite.”
  4. You should see the order turn blue and see a loading icon appear to indicate the order is posting. Once it changes back to green, the order has updated, and you can check NetSuite again.
  5. If you still do not see fields showing up in NetSuite, but you have setup the mapping for that field in FarApp, try manually adding the values to those fields. If you cannot, or if NetSuite deletes the values after you save the order, then there is setup you need to do on your NetSuite account to post to these fields. Once you are able to manually enter values into those fields, FarApp will be able to post to those fields as well.
  6. If all the fields are present, congrats! You have successfully pulled in a NetSuite order using FarApp. Continue to the “Setting Up Order Sync” so we can start automatically pulling in your orders.

Setting Up Order Sync

Before you can setup order sync on app.farapp.com you will need to select your “Order Cutoff Date” for your connector. Follow these steps to set this up:

  1. Click the gear icon in the top right corner of app.farapp and select 'Settings' from the menu that appears
  2. Select "Marketplace/Cart Settings" from the menu on the left (If you have only one Marketplace, instead of Marketplace/Cart it will say the name of the Marketplace, ex: "Amazon Settings"), and then select 'General Settings'.
  3. If you have multiple Marketplaces or accounts, make sure you select the appropriate ones from the blue menu bar at the top of the page.
  4. You should see a date entry field that says 'Import orders created after' (for setting up Amazon you will see two date entry fields, one for your MFN orders and one for your FBA orders) (Examples pictured below)
  5. Select the date that you want to start importing orders from

General Order Cutoff Date:

Enabling Order Sync and Fulfillment Sync

Now that you have successfully imported an order to FarApp you can enable Order sync for your channel. Here are the steps to accomplish this:

  1. Click the “Dashboard” tab from the menu at the top of the page.
  2. Click the “Edit” button to the right of your connector.
  3. To activate your Order sync, click “Order Sync: Inactive”, you should see it change to “Order Sync: Active.”
  4. To activate your Fulfillment Sync Click "Fulfillment Sync: Inactive", you should see it change to "Fulfillment Sync: Active"
  5. Check the Orders screen periodically. You should start to see orders come in every 20 minutes and fulfillments post back to your channel every 90 minutes. (If you have a Magento or Shopify connector, FarApp is able to sync orders from these storefronts in real-time. Please follow the steps here for Magento: https://support.farapp.com/hc/en-us/articles/226258787-Setting-Up-Real-Time-Order-Sync-For-Magento and here for Shopify: https://support.farapp.com/hc/en-us/articles/226346468-Setting-Up-Real-Time-Order-Sync-For-Shopify)

Setting Up Product Sync for Your Storefront

FarApp syncs products from NetSuite to your storefont. FarApp accomplishes this through its Product Mapper, which takes the NetSuite data for your items and translates it so that your posting channel will recognize and accept this data. You can access your Product Mapper here: https://app.farapp.com/settings#/marketplace_cart_settings/product_sync

FarApp offers two types of product sync 1) Full Product Sync and 2) Price/Qty Sync. We have customers who use one, the other, or both on their connectors. Here's what they do:

  1. FarApp syncs full product data such as title, description, images, price, quantity, etc from NetSuite to your storefront.
  2. FarApp only syncs price and/or quantity data from NetSuite to your storefront. You have the option of only syncing quantity data, price data or both. The SKU's using this sync must already exist in the storefront. Since FarApp is only sending price and/or quantity data to the storefront along with the SKU it wants to update, FarApp does not actually possess enough information to create a SKU on the storefront. This means that the SKU should already exist on the storefront with the title, description, images, etc that you want.

For more information on the two types of product sync, please see this article: https://support.farapp.com/hc/en-us/articles/225117028-Full-Product-Sync-and-Price-Qty-Sync

Storefront Flag Field

Regardless of the type of sync you are doing, FarApp requires a custom field for use as a “Storefront Flag” – one for each storefront that FarApp posts products to (Magento, Amazon, eBay, etc.). (Note: if you have multiple accounts, there will be one flag for each account.) This allows you to add/remove items on the storefront by setting the value in NetSuite.

If you installed the FarApp for SuiteSuccess bundle above, FarApp would have created your flag field(s) for you. You can enter the following values for a flag field on an item:

FarApp for SuiteSuccess Storefront Flag Field Valid Values

Value
Definition
Notes
(blank) or "Ignore Item"
Ignored by FarApp FarApp will not load data from NetSuite if the flag field is blank.
Add/Update Item
Add/Update product data to storefront.  
Remove Item
Delete product/listing from storefront. Once an item has been flagged as "Add/Update Item", it is VERY important that it be flagged "Remove Item" when you want the item delisted. Setting a "Add/Update Item" flag to blank or "Ignore Item" means that FarApp will NOT load updates from NetSuite, and will remember that the item was flagged "Add/Update Item".
Post Children as Stand-Alone
Parent of stand-alone items (“Post Children as Stand-Alone” means post only Children). This is currently only supported for Amazon and eBay. Used for NetSuite matrix-item parents. Children will post as stand-alone (non-variation) items. FarApp needs the parent data to populate the children, so this tells FarApp to load, but not post, the parent data.

 

If you did not install the FarApp for SuiteSuccess bundle in NetSuite, you will need to create a custom item field for each Storefront Flag. The field(s) MUST be a single-character, free-form text field. This article explains how to create custom fields for your items: https://support.farapp.com/hc/en-us/articles/236072108-Adding-Custom-Item-Fields-in-NetSuite Items with this flag set to “Y” are added/updated on the storefront. Items with the flag set to “N” will be deleted from the storefront. Items where the flag is blank will be ignored by FarApp.

FarApp will load (from NetSuite) all items that have a value in the Storefront Flag field, and ignore any items that don’t. By only flagging items that need to be posted (add/update/delete), you remove clutter, reduce errors, and improve processing time for your products.

Here are the valid values you can use for a flag field that you set up yourself as a free-form text field:

Free-Form Text Field StoreFront Flag Valid Values

Value
Definition
Notes
(blank)
Ignored by FarApp FarApp will not load data from NetSuite if the flag field is blank.
Y
Add/Update product data to storefront.  
N
Delete product/listing from storefront. Once an item has been flagged as Y, it is VERY important that it be flagged N when you want the item delisted. Setting a Y flag to blank means that FarApp will NOT load updates from NetSuite, and will remember that the item was flagged Y.
C
Parent of stand-alone items (“C” means post only Children). This is currently only supported for Amazon and eBay. Used for NetSuite matrix-item parents. Children will post as stand-alone (non-variation) items. FarApp needs the parent data to populate the children, so this tells FarApp to load, but not post, the parent data.


The basic process of using the flag field is that items should go from blank to Y or Add/Update Item when you want them to list. They should go from Y or Add/Update Item to N or Remove Item when you want them deleted. After they’ve been deleted, they should then be “blanked” so that FarApp will eventually purge them and remove clutter. Items should NOT go from blank to N or Remove Item, as this will cause FarApp to try to delete items that don’t exist on the storefront, and will produce errors. Similarly, changing a flag from Y or Add/Update Item to blank tells FarApp to stop updating the item-data from NetSuite, so it will remain on the storefront without being deleted (and may be updated, depending on the storefront and your setup configuration).

You can read more about flag fields here: https://support.farapp.com/hc/en-us/articles/217185977-Storefront-Flag-Fields

Once you've set up the flag field in NetSuite you can begin setting up your product mappings.

Setting Up Full Product Sync or Price/Qty Sync Mappings

  1. To set up either of the product syncs, go to https://app.farapp.com/settings#/marketplace_cart_settings/product_sync. For an explanation of how to use the page, please see this article: https://support.farapp.com/hc/en-us/articles/225798028-Product-Inventory-Sync-Data-Mappings-in-app-farapp-com
  2. If you are setting up Price/Qty Sync for your storefront, click Add New Category and select [YourStorefront'sName]PriceQty from the dropdown menu.
  3. If you are setting up Full Product Sync for your storefront, click Add New Category and select [YourStorefront'sName] from the dropdown menu.
  4. Once you have added the category you want to work with you will need to set up a mapping for the required fields: Flag Field Setting and CATEGORY.
    1. To add a mapping click the Add Mapping Row button near the bottom left of the page.
    2. Select a storefront field to map from either the Required, Standard or Uncommon drop down menus.
    3. Click "Add Mapping" and close the popup window. You can then click on the Category mapping and configure it. Please read the help text in the new popup window that will let you know how to construct the mapping.
  5. Next you will need to repeat steps similar to those above to set up mappings for the Required fields for your storefront. Each storefront has a different list of required fields, and the specific integrations guides for each storefront will explain this more in detail.
  6. Then you will probably need to set up mappings for the most of the Standard fields.

Creating a Test Product in NetSuite

These steps will walk you through creating a test product to use to confirm that FarApp posts it to your marketplace/cart correctly.

  1. Make sure you are logged into your NetSuite account.
  2. Navigate "Lists" > "Accounting" > "Items" > "New" (to create a new item)
  3. Fill out the required fields for your particular Marketplace/Cart:
    1. Magento: flag field, attribute_set, description, name, price, product_websites, qty, short_description, sku, status, tax_class_id, thumbnail, type, visibility, weight
    2. Fill out any other fields that you have set up mappings for
    3. Copy the Internal ID (should be near the top left of your screen) of product you just created.

Retrieving a Test Product Into FarApp and Posting it to a Storefront

Once you have completed these mappings and created a test product with all the necessary fields populated (including the flag field), you are ready to retrieve your first product into the FarApp dashboard's Products Page. You will not need to do this for all your products; FarApp will do this automatically once it is completely configured, but we will retrieve and post one item as a test product to confirm that the mappings you created above are working.

  1. Navigate to the Products Page in your FarApp dashboard: https://app.farapp.com/products
  2. Click on the gear icon in the blue bar > Retrieve Product from NetSuite
  3. A new window will appear. Enter the internal ID of the product you want to test with into the field and click "Retrieve." The internal ID is an identifying number that NetSuite assigns to your items.
  4. If do not see your product appear after retrieving it, please see this article: https://support.farapp.com/hc/en-us/articles/226283328-Why-didn-t-my-product-appear-in-the-Products-page-after-retrieving-it-

Now that you have retrieved your first product into FarApp, FarApp needs to post the product to your storefront. Again, this is something that FarApp will do automatically once it has been completely configured, but we will manually tell the item to post now in order to confirm that it posts correctly.

  1. From the Products Page, click on the Pen & Paper icon to the right of your test item > Post to [Storefront].
  2. The process to post a single item can sometimes take up to several minutes. Please wait to confirm that you see that the status on the item changes from "In FarApp" to "Posted to [Storefront]." If the product row turns red at this step and you see an error message when hovering your cursor over the row, please takes steps to correct the error and try posting the item again (which may require reloading the item from NetSuite who you make changes to the item there). If the item says that it has posted, you can navigate to your store and check the data on the item there. The goal is that all the data for you item in NetSuite will have synced to the storefront via the mappings that you created.

Enabling Product or Price/Qty Sync

Now that you have successfully posted a product to your storefront, you can enable Product Sync or Price/Qty Sync for your storefront's channel. Here are the steps to accomplish this:

  1. Click the “Dashboard” tab from the menu at the top of the page.
  2. Click the “Edit” button to the right of your connector.
  3. Click “Product Sync: Inactive” or "Price/Qty Sync: Inactive" as appropriate. You should see it change to “Product Sync: Active.” or "Price/Qty Sync: Active."
  4. Check the Products Screen periodically. You should start to see your products be retrieved into FarApp and then posted to your storefront.

You have now successfully posted your first product via FarApp and enabled your Product or Price/Qty Sync. If you skipped the Order Sync section earlier in order to set up your Product Sync first, please return to that section now to complete the set up of your Order Sync.

Setting Up Refund Sync for Your Storefront

Please fill out the desired settings under the Refund tab here: https://app.farapp.com/settings#/marketplace_cart_settings/refund_sync Most customers leave the positive and negative refund adjustment fields blank (if they are required, that will be discovered in later steps). You will notice the FarApp treats refunds as happening in one of two ways: 1) the refund either originates in the storefront or 2) the refund originates in NetSuite (Amazon and Jet are unique. Please see the Amazon Integration Guide here https://support.farapp.com/hc/en-us/articles/230497688-Amazon-Integration-Guide for the set up for Amazon, and see this article for Jet: https://support.farapp.com/hc/en-us/articles/230172508-Issuing-Refunds-in-Jet). You will need to perform all your refunds for that channel in that direction. You will only need to populate the setting on that page for the direction you will sync the refunds in.

After you have filled out these settings, please contact FarApp by opening a support ticket and supply an order that you would like to test refund sync with. Please let us know which direction you will be syncing refunds in. The order you want to test refunds with should already be refund in either the storefront or NetSuite depending on which direction you want refunds to flow. Our operations team will assist you by test posting the refund data to NetSuite or the storefront as appropriate for you. Once you confirm that the refund appears as expected in your NetSuite or your storefront, you can turn on your Refund Sync for that particular direction in your dashboard here: https://app.farapp.com/storefronts/Amazon/default/edit You will never have both directions active at the same time (except for Jet).

You can monitor your refunds in FarApp using this screen: https://app.farapp.com/othertransactions Be sure to select either your storefront or NetSuite as your source channel as appropriate and also select the appropriate transaction type.

Setting Up Your Notification Settings

It is important to monitor the "health" of your FarApp integration by staying on top of any orders, items, refunds, etc that might have errors when FarApp tries to sync data for them. The best and easiest way to do this to configure you Notification settings in FarApp so FarApp will send you daily error report emails for your different types of syncs.

You can manage all the various notifications that FarApp can send at https://app.farapp.com/settings#/notification_settings. All settings accept a comma-separated list of email addresses to send the reports to. Some notifications may not be sent unless your FarApp account is currently processing those types of feeds. For example, if FarApp isn't setup to process custom record updates, then adding your emails to that field won't have an effect.

 

Connecting FarApp to Your 3PL’s

ShipStation

FarApp provides a connector between ShipStation and NetSuite that allows you to pull orders in from NetSuite to ShipStation and push fulfillments back from ShipStation to NetSuite. In order to set this up, please follow the steps in our ShipStation Integration Guide: https://support.farapp.com/hc/en-us/articles/115011334208-ShipStation-Integration-Guide

ShipWorks

FarApp provides a connector between ShipWorks and NetSuite that allows you to pull orders in from NetSuite to ShipWorks and push fulfillments back from ShipWorks to NetSuite. In order to set this up, please follow the steps in our ShipWorks Integration Guide: https://support.farapp.com/hc/en-us/articles/115011371928-ShipWorks-Integration-Guide

Shipwire

FarApp provides a connector between Shipwire and NetSuite that allows you to pull orders in from NetSuite to Shipwire and push fulfillments back from Shipwire to NetSuite. In order to set this up, please follow the steps in our Shipwire Integration Guide: https://support.farapp.com/hc/en-us/articles/115011378588-Shipwire-Integration-Guide

ShippingEasy

FarApp provides a connector between ShippingEasy and NetSuite that allows you to pull orders in from NetSuite to ShippingEasy and push fulfillments back from ShippingEasy to NetSuite. In order to set this up, please follow the steps in our ShippingEasy Integration Guide: https://support.farapp.com/hc/en-us/articles/115011373528-ShippingEasy-Integration-Guide

Other

FarApp supports a number of additional 3PL's. You can see a full list of the 3PL's here: https://support.farapp.com/hc/en-us/articles/216635908-Supported-Marketplaces-Carts-and-3PLs We are working on developing documentation for the set up steps for these other 3PL's as well and will include those steps here once they are complete.

 

Custom/Bespoke Connectors

FarApp supports a SOAP-like interface for posting orders. If you need to post orders directly to FarApp, we can provide a listener to receive XML orders and then relay them as required. A URL and credentials will be provided during the setup process. Please see this article for the set up process: https://support.farapp.com/hc/en-us/articles/217185947-Pushing-Orders-to-FarApp

 

Other Connectors

Please submit a support ticket and we'll set up the connector for you.

 

Credit Cards and PCI Compliance

FarApp imports credit card tokenization details by default in order to maintain PCI compliance. Most storefronts do no support capturing full payment details, but if they were to support this and FarApp were to import this data to NetSuite for you, it would be in breach of PCI compliance.

If you are using the same payment gateway in your storefront and NetSuite, then you should not have any issues authorizing a payment in the storefront and capturing the payment in NetSuite. In some situations, FarApp will need to send additional information via your connector to NetSuite while still maintaining PCI compliance. If you believe this might be the case, please contact us. You can also choose to perform both the authorization and capture in the storefront. If you are performing the capture in NetSuite, you can also perform your refunds in NetSuite.

 

Next Steps and Additional Information

Please see this article if you have any questions on the process for going live with FarApp: https://support.farapp.com/hc/en-us/articles/115012240747-The-Go-Live-Process

Please contact FarApp if you have any questions on the step above or have any suggestions for how we can improve our documentation.

Posting products to a storefront can be particularly complicated, so please let us know if you need any assistance deciding between the two types of syncs.

Comments