Customize an Interface

Customize Interface allows you to customize the way data is translated between QuickBooks, your carrier system(s), and ShipGear. Data is translated using field maps and value translations.

Field Maps define fields that are mapped between the carrier system or ShipGear Input fields and your Quickbooks documents ((Sales Receipts, Invoices, etc.).

ShipGear Input fields are like a reverse map from QuickBooks to ShipGear, where you can choose fields from QuickBooks to write to the ShipGear database. That data can then be used in your eNotify email notifications, or viewed and exported in the ShipGear Dashboard.

Value Translations define how values from the mapped fields are translated between QuickBooks and the carrier system or ShipGear; for example, 1ST SAT  in the ERP system can be translated to mean FedEx Priority Overnight®.

Write-Back is how ShipGear writes freight and tracking information back to your QuickBooks documents, including the use of custom rules to control how and when write-back occurs.  You can set up write-back for each carrier independently.

This combination of field maps, value translations, and write-back settings defines the "Interface". ShipGear comes with a default interface (My Interface) that allows you to begin shipping immediately. You do not need to set up or customize an interface in order to ship.

If you would like more control over how data is automatically translated from QuickBooks into the carrier system and ShipGear, the following sections show you how to customize or fine tune an Interface.

Open ShipGear Exchange and click the Customize Interface button.

To view or customize Field Mapping, Value Translations, and Write-Back settings, select a document from your Interface.



 

• Field Mapping and Value Translations for UPS OnLine WorldShip®

• Field Mapping and Value Translations for FedEx

• Field Mapping for ShipGear Input Fields

• Write-Back

Create/Modify Interfaces

Create a new interface

1. In the ShipGear Exchange window, click the Customize Interface button.

2. Click the New Interface button, located under the list of Interfaces.
   
   
   
   
   

3. When the Create New Interface dialog box appears, type a name for the interface in the field provided.

4. In the Create From: field, select the existing interface on which you want to base the new interface. These can be DEFAULT, My Interface, or any other interfaces you have created. The new interface will inherit any field mapping, Value Translations, and write-back setup characteristics of the interface you’ve chosen.
   
   
   
   
    

5. Click Next and select the companies that will use this interface by enabling the check box next to each company’s name.
   
   
   
    

6. Click Finish.

7. If you would like to enable ShipGear eNotify, FedEx ShipAlert, or UPS Quantum View for this new interface, complete the Wizard.

Delete an interface

1. In the ShipGear Exchange window, click the Customize Interface button. 

2. Select the interface name from the list. 

3. Click Delete Interface. 

4. If you really want to delete the interface, click Yes when prompted.
   
   

Rename an interface

1. In the ShipGear Exchange > Customize Interface window, select the Interface name by clicking on it.

2. Click the Interface name once more.
   
   
    

3. Type the new name.

4. Press the Tab key.