Shipping Integrations

From LOCATE
Jump to: navigation, search

Main Page

Service Integrations

General

LOCATE currently integrates with Endicia, FedEx, ShipStation and UPS Worldship for shipment processing. Cartons must be completed or locked in LOCATE in order to be made available to shipping software. This may be accomplished by clicking the lock icon on individual cartons, or finishing the pack.

Prerequisites

  1. Create a shipping service in LOCATE. Click here for step-by-step instructions.
  2. Create a database user in LOCATE. Click here for step-by-step instructions.
  3. Prepare your ODBC database connection. Click here for step-by-step instructions.
  4. Setup your shipping integration: Endicia, FedEx, ShipStation, UPS.

Note: If you have multiple shipping integrations, you will need individual shipping services and database users for each integration.

Back to Top

Prepare ODBC Database Connection

Once you have completed the first two prerequisites, you will need to setup the local Open Database Connectivity (ODBC) connection. The ODBC connector will need to be installed and configured on each workstation at which the shipping software is installed.

  1. Download the 32-bit MySQL ODBC installer here: https://dev.mysql.com/downloads/connector/odbc/
  2. Run the installer with the Default settings.
  3. Open the Data Source ODBC window by opening the Start Menu and searching "Data Source".
    • For a 32bit system, navigate to Control Panel > Administrative Tools > Data Source ODBC.
    • For a 64bit system, Run the Datasource editor from this path c:\Windows\SysWOW64\odbcad32.exe
  4. Click onto the System DSN tab and click Add.
  5. Select MySQL ODBC Unicode Driver from the list.
    • If you are not seeing MySQL as a Driver option, please Run the Datasource editor from this path c:\Windows\SysWOW64\odbcad32.exe
  6. Click Finish.
  7. Next, you will be prompted to complete the ODBC setup. Brackets below indicate information provided by the Database User previously created in LOCATE. Note that all information is case sensitive.
    • Each integration has a different Data Source Name:
      • UPS: locate_ups
      • Endicia: locate_endicia
      • FedEx: locate_fedex
    • TCP/IP Server: [host], Port: 3306
    • User: [username]
    • Password: [password]
    • Click Test.
      • If you do not receive a successful test message, double check the information above.
    • Select your LOCATE database from the dropdown menu.
  8. Click OK.

Now you may proceed with setting up your shipping integration: Endicia, FedEx, ShipStation, UPS.

Back to Top

Endicia

The Endicia integration will import one carton at a time from LOCATE, based on the associated sales order number. The carton must be ready to ship in LOCATE, have USPS selected as the carrier, and have no tracking number entered. As changes are made in the Endicia application, LOCATE will automatically update. Note that Endicia does not allow for partial weights, and will therefore be rounded upon export from LOCATE.

System Requirements: Endicia Professional

Integration Setup

In order to set up the Endicia integration, you will need to complete the prerequisites and have Endicia and Dazzle installed. If you do not have Endicia and Dazzle installed, you can do so here.

  1. In Endicia, open the Edit menu and select Preferences.
  2. Click onto the Data Source and Post-Back tab.
  3. Next to Order Lookup, choose Database or CSV/Text File from the dropdown menu, and click Configure to the right.
  4. Click New.
    • Click Next.
    • Select ODBC Connection, and click Next.
    • ODBC Data Source: locate_endicia
    • User Name: [database user name]
    • Password: [database user password]
    • Click Next.
    • Click OK.
  5. Now you will be prompted to create a SELECT Statement
    • Click Next.
    • Select endicia_package_import, and click Next.
    • Select order_number, and click Next.
  6. Fill in the following fields on the Package Details tab:
    • Order Number: order_number
    • Reference ID 2: carton_id
    • Mail Class: carrierservicelevel
    • Length: length
    • Width: width
    • Height: height
    • Weight: weight
    • Weight is in pounds checkbox: check
      • Note: LOCATE assumes all weights entered are in pounds. Please check the box 'Weight is in pounds' to ensure weight entered is calculated correctly.
  7. Now you will want to map the individual carrier service levels in LOCATE.
    • Click Edit Mail Class Codes, next to the Mail Class mapping.
      • If there is a carrier service level missing from the list, you will need to add it into LOCATE first, then return to this screen to finalize the mapping. For more information on adding carrier service levels in LOCATE, continue here.
    • Select the mail class code from the drop-down menu. For example: Priority Mail.
    • The database field value can be found in LOCATE.
      • Navigate to the Setup Menu > Carriers, and select USPS.
      • In the Service Levels section, find the API Field Name for the carrier service level you would like to add.
        • Note: You may only map one service level per API Field Name. If you have more than one type of Priority Mail in Endicia, you will want to add them into LOCATE.
      • Copy and paste into Endicia.
      • Click the blue plus sign to add the mail class code.
    • Once complete, click OK.
  8. Fill in the following fields on the Recipient Address tab:
    • Name: attention
    • Company: account_name
    • Address 1: address_1
    • Address 2: address_2
    • Address 3: address_3
    • Address 4: address_4
    • City: city
    • State: state_province_abbreviation
    • Postal Code: postal_code
    • Country: country_abbreviation
    • Email: emailaddress
    • Phone: phonenumber
  9. Lastly, fill in the following field on the Rubber Stamps Tab:
    • Rubber Stamp 1: carton_id
  10. Click OK.

Back to Top

Field Mappings and Validations

Import

Now that the integration has been setup, you should be able to import a carton. Note that carton must have USPS selected as the carrier, and it must be completed in the Packing stage; do not start a shipment.

  1. In Endicia, enter the sales, purchase, transfer, or use order number from LOCATE.
    • Note that Endicia does not allow for a distinction of order numbers. Therefore, if a sales order and transfer order, for example, have the same order numbers then Endicia will import all cartons for both orders.
  2. Click Retrieve.

You should see your carton details populated here. Once the shipment has been completed, the integration will post back the shipping cost and tracking number to the carton in LOCATE.

Back to Top

Export

  1. In the Edit menu, select Preferences.
  2. Click onto the Data Source and Post-Back tab.
  3. In the Post-Back Data section, click Configure.
  4. In the upper left corner, click the New Data Map icon.
    • Click Next.
    • Select ODBC Connection and click Next.
    • ODBC Data Source: locate_endicia
    • Username: [database username]
    • Password: [database password]
      • Click here for more information about the database username and password.
  5. Next to the Table field, click Select and choose "shipping_export_endicia".
  6. Select the appropriate mapping for each field with the Select button on the right:
    • Order Number: order_number
    • Postage Amount: package_cost
    • Tracking Number: tracking_number
    • Transaction ID: package_id
    • Actual Weight: weight
  7. Click onto the Rubber Stamps sub-tab.
  8. Next to the Rubber Stamp 1 field, click Select and choose carton_id.
  9. Click OK
  10. In the Post-Back Data section click Options.
  11. At the top of the window, check the boxes for the following items:
    • Automatically post back data.
    • Always insert new records
      • You may show and hide any of the fields in the Display Columns section, per your preferences. This will have no impact on the integration with LOCATE.
  12. Click OK.
  13. Click OK again.

Back to Top

FedEx Ship Manager

System Requirements: FedEx Ship Manager

Integration Setup

In order to set up the FedEx integration, you will need to complete the prerequisites and have FedEx installed.

  1. Download the .xml files here, which provide the database field mapping.
  2. Move the files to C:\ProgramData\FedEx\Integration\Profiles
  3. Restart the FedEx program.

Now you may proceed with importing your data from LOCATE.

Back to Top

Field Mappings and Validation

Import

Now that the integration has been setup, you should be able to import cartons.

  1. In the Integration menu, select the type of import you would like to perform:
    • LOCATE_BATCH - This option will import all available cartons from LOCATE, regardless of what order they're associated to.
    • LOCATE_PO - This will prompt you for a purchase order number from LOCATE, and will bring in all cartons associated to that order. This is typically used when processing outsource bill of material type purchase orders.
    • LOCATE_SO - This import allows you to enter a sales order number from LOCATE, and will bring in all cartons associated to that order.
    • LOCATE_TO - This import will prompt you for a transfer order number from LOCATE, and will bring in all cartons associated to that order.
    • LOCATE_UO - This import will prompt you for a use order number from LOCATE, and will bring in all cartons associated to that order.
  2. In the Lookup field, enter the appropriate order number and click OK.

The default profiles will map the weight of the carton to FedEx when an order is imported. However, if you would rather default to using a scale you can update your ShipManager settings:

  1. Go to Customize -> System Settings.
  2. Click Modify on your account and select 'Scale is attached' and 'Pre-read scale weight'. Click OK through the warning and click Save.

Additionally you will want to remove the weight mapping from the LOCATE profile or it will overwrite the initial weight provided from the scale:

  1. Go to Integration -> FedEx Integration Assistant and choose the existing profile you wish to modify.
  2. Go to the Import -> Match tab and scroll down to where it says Package - Weight.
  3. Click the X to remove the weight mapping and then click Save.
  4. Finally, restart Ship Manager in order for the changes take effect.

Back to Top

Export

Once a shipment has been processed through FedEx, the following pieces of information will be exported back to LOCATE:

  1. carton_id - this is the primary identification number for cartons in each software. Database reference only.
  2. Tracking Number
  3. Net Charge - The cost of the individual carton.
  4. Total Customer Charge - The total value of the whole shipment.
  5. Height
  6. Length
  7. Width
  8. Number of Packages
  9. Service Type - This is the carrier service level.
  10. Weight


Back to Top

ShipStation

ShipStation is a shipment management and fulfillment hub for multiple carrier types. Orders which have been issued in LOCATE are imported and fulfilled through ShipStation. Upon completion of fulfillment in ShipStation, the order will be auto-completed in LOCATE from pick through pickup.

Partial shipments and drop ship line items are not supported in ShipStation. Drop ship line items must be fulfilled via purchase order.

System Requirements: ShipStation

Service Settings

Auto-Pickup Orders on Shipment Post Back
  • Yes - Once the order has been completed in ShipStation, the order will post back shipping details to LOCATE and then auto-work until complete.
  • No - Once the order has been completed in ShipStation, the order will post back shipping details to LOCATE and Pickup will need to be ran manually.
Custom Store Password
Custom Store Username
Include Discounts when Syncing Orders
Include Fees when Syncing Orders
ShipStation Custom Cart XML URL

A unique URL generated by LOCATE to link ShipStation.

Show in ShipStation by Default

This setting determines whether or not issued orders should be automatically imported into ShipStation.

  • Yes - Orders will be automatically flagged to sync with ShipStation, and any orders that you do not want to sync will need to be manually updated.
  • No - Orders that you want to sync to ShipStation will need to be manually selected to import.
Use LOCATE for Picking
  • Yes - The order will need to be fulfilled in LOCATE and will not show in ShipStation until the Pick step has been completed.
  • 'No - The order will go directly into ShipStation for fulfillment and it will auto-work in LOCATE up until the Pickup step. NOTE This is not recommended if the same product is stocked in multiple locations.

Back to Top

Integration Setup

In order to set up the ShipStation integration, you will need to complete the prerequisites, and have the desired carriers and shipping accounts setup in ShipStation. For more information about how to prepare ShipStation, you'll need to work directly with their support team.

  1. In ShipStation, click onto the Welcome tab.
  2. Click Connect a channel.
  3. In the search bar, search for Custom Store and click the Custom Store icon.
  4. In the pop-up modal, complete the following fields:
    • URL to Custom XML Page - In LOCATE, navigate to the service profile page and copy the "ShipStation Custom Cart XML URL" hyperlink. Paste it into this field in ShipStation.
    • Username - In LOCATE, navigate to the service profile page and copy the "Custom Store Username". Paste it into this field in ShipStation.
    • Password - In LOCATE, navigate to the service profile page and copy the "Custom Store Password". Paste it into this field in ShipStation.
  5. Leave the remaining information in item #3 as-is, and click Test Connection.

You should receive a success message. When you are ready to complete setup and begin importing orders into ShipStation, click Connect.

Back to Top

Field Mappings and Validation

Import

Once your Integration Setup is complete, you may view imported orders on the orders tab.

If you've selected No for the service setting "Show in ShipStation by Default", you must manually select orders for import.

Custom fields will be automatically created on the sales order to allow users to map internal notes or gift messages. The new custom fields are as follows:

  • Show in ShipStation
  • Internal Notes
    • LOCATE will specifically check if an "Internal Notes" textarea customfield has been created on the customer, and if so it will copy the contents of that custom field into the ShipStation Internal Notes custom field on sales order creation.
  • Is a gift?
  • Gift Message

Once an order has been imported, you can view the status on the Audit tab of the order in LOCATE.

Back to Top

UPS Worldship

The UPS Worldship integration will import cartons from LOCATE, based on the associated order number. The cartons must be ready to ship in LOCATE, have UPS selected as the carrier, and have no tracking number entered. As changes are made in the UPS application, LOCATE will automatically update.

System Requirements: UPS Worldship

Integration Setup

In order to set up the UPS Worldship integration, you will need to complete the prerequisites and have UPS Worldship installed.

  1. Download the .dat files here, which provide the database mapping.
  2. Move files to C:\ProgramData\UPS\WSTD\ImpExp\Shipment
  3. Restart UPS.
  4. In the Import/Export menu, click Create/Edit Map.
  5. Scroll down to LOCATE SO and click ODBC login.
  6. Enter the Database User's name and password from LOCATE.
  7. Click OK.
  8. Repeat for any other import/export types you'd like to use (LOCATE_BATCH, LOCATE_TO, LOCATE_PO, LOCATE_EXPORT).

For each default UPS Worldship profile, you should also ensure that there are no Reference check-boxes selected to allow the correct information to be exported into LOCATE. To do so, following the steps below:

  1. In the Tools Menu, click Create/Edit Profile.
  2. In the section on the right, click into the Reference sub-tab.
  3. Un-check "Use on all packages" checkbox for all lines.
Customer PO Number (Optional)

The default UPS Worldship profiles may be modified to include mapping of the Customer PO Number. We recommend modifying a copy of the profile to ensure that the changes are not overwritten when the default profiles from LOCATE are updated.

  1. In the Import/Export menu, click Create/Edit Map.
  2. Scroll down to LOCATE_SO and check customer_po_number.

Back to Top

Field Mappings and Validation

Import

Now that the integration has been setup, you should be able to import cartons from LOCATE. Note that cartons must be completed in the Packing stage, and there should not be a shipment started.

  1. In UPS, open the Keyed Import Menu, and select More.
  2. Select the type of import you would like to perform:
    • LOCATE_BATCH - This option will import all available cartons from LOCATE, regardless of what order they're associated to.
    • LOCATE_PO - This will prompt you for a purchase order number from LOCATE, and will bring in all cartons associated to that order. This is typically used when processing outsource bill of material type purchase orders.
    • LOCATE_SO - This import allows you to enter a sales order number from LOCATE, and will bring in all cartons associated to that order.
    • LOCATE_TO - This import will prompt you for a transfer order number from LOCATE, and will bring in all cartons associated to that order.
    • LOCATE_UO - This import will prompt you for a use order number from LOCATE, and will bring in all cartons associated to that order.
  3. Click Import.
  4. Enter the appropriate order number and press Enter on your keyboard.

Back to Top

Export

Once a shipment has been processed through UPS Worldship, the following pieces of information will be exported back to LOCATE:

  1. carton_id - This is the primary identification number for cartons in each software. Database reference only.
  2. Tracking Number
  3. Service Code - The carrier service level.
  4. Package Cost - The cost for an individual carton. The sum of these costs will be added to the invoice in LOCATE as a shipping line item.
    • Note: The default value is the "Package Published Charge". If desired, this may be changed by editing the LOCATE_EXPORT map and selecting another value such as the "Package Negotiated Rates Charge.
  5. Shipment Cost - This is the total cost for multiple cartons. This is used with multi-carton actions.
    • Note: The default value is the "Total Shipment Published Charge". If desired, this may be changed by editing the LOCATE_EXPORT map and selecting another value such as the "Total Shipment Negotiated Rates Charge".
  6. Currency Code - The type of currency. Currently the only currency recognized by LOCATE is the United States Dollar.
  7. Weight
  8. package_id - The ID of the package in UPS. Database reference only
  9. Total packages - The total number of packages. Database reference only
  10. Voided - If an item was voided in UPS, we will void the carton in LOCATE and roll the items back to the Ready to Ship status.

By default LOCATE will accept the Package Published Charge and apply it to the cartons. If you prefer to use the Package Negotiated Rates Charge, you will need to:

  1. Navigate to the Import/Export menu,click Create/Edit Map.
  2. Scroll down to LOCATE_EXPORT and click Edit.
  3. In the "What You Have Mapped So Far" section at the bottom, find the line "Package::Package Published Charge" and click Disconnect.
  4. In the "WorldShip Fields" column, select field #29 "Package Negotiated Rates Charge".
  5. In the "ODBC Tables" column, select field #6 "package_cost".
  6. Click Connect.
  7. Click OK.
  8. Click Close.

Note: It's recommended to avoid any duplicate mappings in the export. You can check for duplicates by scrolling to the "What You Have Mapped So Far" section at the bottom. If there is a red icon to the far left, this indicates a duplicate mapping for that WorldShip field. Simply highlight the line and disconnect one of the mappings.

Back to Top

Contact Us