Integrating with Shippers
Click here to see this page in full context

Integrating with Shippers

If your company uses shippers, such as UPS and/or FedEx to ship your products, there are several methods you can use to pass information from Apprise to and from the shipper. The following methods can be used to integrate with shippers:

NOTE For information on setting up Apprise Shipment Manager, refer to the Apprise Shipment Manager Installation and Setup Guide. To use Apprise Shipment Manager, you must have an Apprise Shipment Manager license.

NOTE For information on setting up UPS integration, refer to the Apprise UPS Integration Guide.

You can use any combination of these freight integration methods.

Example Your company uses UPS and FedEx for shipments. You can use the cloud-based UPS integration for UPS shipments, the FSMS integration for FedEx domestic shipments, and the text file integration with a standalone shipping application for FedEx international shipments.

The following table provides a comparison of these methods:

 

Text File Integration

FSMS Integration

Apprise Shipment Manager

Cloud-Based UPS Integration

Freight software application

Any standalone freight application that can accept delimited file shipment data, such as UPS WorldShip

FedEx Ship Manager Server on-premises software

ProShip

UPS cloud-based API services

Integration technology

Delimited text file export and import

TCP calls to FSMS

XML

Web-based shipping APIs (using XML and SSL)

Apprise prints tracking label using BarTender

No, the standalone freight system handles tracking label functions

No, FSMS handles all label printing

 

Labels can be printed as an image in BarTender or ZPL code can be sent directly to a ZPL-compatible label printer

Apprise end of day process

Import tracking numbers from third-party software via delimited text files (Package Import). Any other end-of-day tasks are managed in the third-party application

There is no need to perform any end-of-day process.

There is no need to perform any end-of-day process.

There is no need to perform any end-of-day process.

Tracking labels print from Apprise

No, the third-party application handles all label printing calls

Yes

Yes

Yes

Banding integration

Banding is done in the third-party application

Yes

Yes

Yes

Freight Calculations

Freight calculations are handled differently for each integration, as follows:

Setting up Integration

For information on setting up the integration, see one of the following:

Note Thoroughly test the integration before using in a production environment.

Text File Integration Setup

Text integration allows you to export data from Apprise to shipping software via text files, and then to export data from the shipping software back to Apprise. For example, if you use WorldShip, you can use this integration method to link data between Apprise and WorldShip.

Note For information on setting up WorldShip for integration with Apprise, see External Label Interface FAQ.

The interface to the third-party system functions during ship confirmation. During ship confirmation, a text file is created in a user-defined folder. This file is then used in the shipper system to capture ship information and print labels.

The following table illustrates the general requirements:

Process

Apprise Program

UPS System Option

Comments

Products picked are confirmed

Pick Demand Confirm

 

Option to create an external file default.cvs with shipping information related to just the pick demand being confirmed.

Import the shipping information into the UPS system

 

Batch Processing Commands

Loads pick demand data into the UPS batpackage table. Can be set up as a bar-coded macro to automatically print out shipping labels.

Invoices or packing slips are created or printed after pick demand confirmation

Pick Demand Confirm

 

Depends on whether the customer wants to send the invoice or a packing slip with the package.

To set up text integration:

  1. In Shipper Interface Maintenance, set up one or more shipper interfaces. The shipper interface controls the text files that are used for the integration. To do this perform the following substeps:

    1. Click the New button in the ribbon.

    2. Enter a name for the shipper interface, such as UPS, in the Shipper Interface field.

    3. Enter the warehouse location prefix in the Location Prefix field. For information on setting up location prefixes, see Location Maintenance.

    4. Click the Lookup button for the Interface Type field, and select UPS WorldShip.

    5. Enter the folder path and text file name to which you want to export shipping data in the Extract Output Path\File field. This should be a location on the application server. Exported data is appended to a file, and cannot be overwritten each time data is exported. This functionality is not supported on an Apprise Client computer.

    6. If you want to associate an order entry additional charge type for the freight charge, enter the charge in the Charge Type field. For information on setting up order entry additional charges, see Order Entry Additional Charge Maintenance.

    7. Enter all other settings for the shipper interface, as needed.

    8. Click the OK button in the ribbon. The shipper interface is created.

  2. In Shipper Maintenance, set up a shipper ID for each service. To do this perform the following substeps:

    1. Click the New button in the ribbon.

    2. Enter a name for the shipper ID in the Shipper ID field.

    3. Enter the name of the service in the Name field.

    4. Enter the Standard Carrier Alpha Code for the shipper in the SCAC Code field. For more information, see Standard Carrier Alpha Code (SCAC).

    5. Enter the 2-digit service indicator in the Service Indicator field.

    6. If the shipper ID is for UPS, enter the UPS-assigned 6-digit shipper code (e.g., 063332 for a specific shipping site) in the Special Shipper Code field. This code is used in the 1Z tracking number algorithm.

    7. Click the Other Options tab.

    8. Click the Lookup button to the right of the Calculation Method field, and select Straight Rate.

    9. Enter a shipper interface you created in step 1 in the Shipper Interface field.

    10. If the service delivers on Saturday only, select the Saturday Delivery check box.

    11. Click the OK button in the ribbon. The shipper ID is created.

The following table provides examples of shipper ID's, service codes, and service names for UPS.

Valid UPS Shipper ID

Valid UPS Service Code

Service Name

1DA

01

Next Day Air

2DP

03

Next Day Air Saver

2DA

05

2nd Day Air

3DS

07

3 Day Select

GNDCOM

09

Ground Commercial

GNDRES

11

Ground Residential

STD

14

International Standard

XPD

15

Worldwide Expedited

XPR

16

Worldwide Express

1DM

17

Next Day Air Early AM

2DM

18

2nd Day Air AM

  1. In Order Entry Additional Charge Maintenance, set up additional charges that are exactly the same as the shipper ID's you set up in step 2. Also, set up a UPSICOD additional charge for adding C.O.D. charges per package.

  2. In Shipper Rate Maintenance, set up shipper rates for UPS services and rates. You can also download the rates from the UPS Website and import the rates in Shipper Rate Import.

FSMS Integration Setup

FSMS is FedEx's server-based application that provides high speed processing of FedEx shipment transactions. You can use FSMS to generate tracking labels, and process FedEx shipments in Apprise.

The FSMS software is provided by FedEx to companies that meet certain shipping volumes. For information about getting FSMS and the minimum hardware requirements for FSMS, contact your FedEx account representative. The Apprise application server and FSMS server communicate with each other over a TCP/IP connection.

After FSMS is installed, a new meter must be established using the FSMS meter registration utility. Meter numbers used on one FSMS server should not be ported over to a different server. After meter setup is completed in FSMS and all tracking, rate, and routing table information is downloaded via the FSMS Demand Download utility, you can proceed with the FSMS setup in Apprise.

Note Windows Firewall may block FSMS connections. If necessary, create firewall exceptions for FSMS utilities and services.

To set up FSMS integration:

  1. Set up label printers. All tracking label printing is handled directly by FSMS. For label printing to function properly, all label printers must be configured on the FSMS server. This typically means putting all label printers on the network. Printers that are configured locally for a client computer running Apprise, and connected via a USB port will not function with FSMS label printing unless the printers are shared on the network and connected properly to the FSMS server.

  2. In Shipper Interface Maintenance, set up one or more FedEx shipper interfaces. To do this, perform the following:

NOTE Perform the same procedure to set up FSMS SmartPost interface. However, you must have entered the appropriate values for SmartPost interface in Shipper Maintenance.

    1. Click the New button in the ribbon.

    2. Enter a name for the shipper interface, such as FedEx, in the Shipper Interface field.

    3. Enter the warehouse location prefix in the Location Prefix field. For information on setting up location prefixes, see Location Maintenance. One FedEx shipper interface is required for each physical location where FSMS is being used.

    4. Click the Lookup button for the Interface Type field, and select FedEx (FSMS).

    5. If you want to associate an order entry additional charge type for the freight charge, enter the charge type in the Charge Type field. This must be done for freight charges calculated by FSMS to be applied to shipments\invoices in Apprise. For information on setting up order entry additional charges, see Order Entry Additional Charge Maintenance.

    6. Enter the FedEx meter number in the Meter Number field. This meter number is established as part of the FSMS installation and configuration process.

    7. Enter the socket host (the name or IP address of the server on which FSMS is installed) in the Server Name field.

    8. Enter the socket port (the port on the server that is listening for FedEx requests) in the Port Number field. The default port for FSMS installations is 2000.

    9. Enter the network address of a label printer you set up in step 1 in the Label Printer field.

      Note Printers can also be set up for specific users and zones in Apprise. The printer set up for the shipper interface is a default printer that will be used if no other printer is specified.

    10. Enter YES in the Use Fedex Interface field.

    11. If you want to specify a formula for calculating freight charges, enter the formula in the Freight Charge Formula field. The formula must have the following format: <multiplier>,<static amount>,<formula with field numbers in square brackets>. If this field is left blank, Apprise will use the total freight calculated by FSMS. The total is the published rates plus extra fees\accessorials minus contracted discounts.

      Note You must enter a + or - before each field number in the formula. If the formula is incorrect, the net rate is used.

    Example You enter the following:

    1,10,+[1338]-[1393]

    The freight charge is calculated as field 1338 subtracted by field 1393. This amount is multiplied by 1, and an additional 10 per package is added to the total freight charge.

    You enter the following:

    3,12,+[37]

    The freight charge is calculated as field 37 multiplied by 3, and then 12 per package is added to the total freight charge.

    1. If you want to specify an FSMS label format type, enter it in the Label Format field. This must be a valid value for the label/printer type as defined in FSMS. For more information, refer to the description of Field ID 187 in the FedEx Ship Manager Server Transaction Coding Reference. FedEx typically uses 4x6 inch label stock. If you are printing to a Zebra-compatible label printer, you can leave this field blank. If you are testing and simply want labels to print to letter/A4 paper via a laser printer, enter DIB.

    1. Click the OK button in the ribbon. The shipper interface is created.

  1. In Shipper Maintenance, set up shipper ID for each FedEx service. To do this, perform the following substeps:

    1. Click the New button in the ribbon.

    2. Enter FedEx in the Shipper ID field.

    3. Enter FedEx in the Name field.

    4. Enter FEDX in the SCAC Code field.

    5. Enter a two-digit code to indicate the service type that is to be used to ship packages in the Service Indicator field. Enter one of the following codes:

    U.S. Domestic Services:

    01 – FedEx Priority Overnight

    03 – FedEx 2Day

    05 – FedEx Standard Overnight

    06 – FedEx First Overnight

    20 – FedEx Express Saver

    70 – FedEx 1Day Freight

    80 – FedEx 2Day Freight

    83 – FedEx 3Day Freight

    90 – Home Delivery

    92 – Ground

    FedEx International Services (including U.S. export):

    01 – International Priority

    03 – International Economy

    06 – International First

    57 – FedEx Europe First

    70 – International Priority Freight

    86 – International Economy Freight

    90 – Home Delivery (CA only)

    92 – Ground (CA only)

          SmartPost:

          SP – SmartPost

Note If you want to choose SmartPost and you enter the code SP in the Service Indicator field, then you must also enter the appropriate field value from SmartPost Identifiers in the Other ID field.

      1. Enter the carrier code in the Special Shipper Code field. Enter one of the following codes:

    FDXE – FedEx Express

    FDXG – FedEx Ground

    FDXT – FedEx Transborder Distribution

    FDXA – All

      1. Click the Other Options tab.

      2. Enter a one-digit code to indicate the payment method for transportation charges in the Shipper Billing Option field. Enter one of the following codes:

    1 – Bill shipper

    2 – Bill recipient or consignee

    3 – Bill third party

      1. Enter a shipper interface you created in step 2 in the Shipper Interface field.

      2. Click the OK button in the ribbon. The shipper ID is created.

    1. In Customer Maintenance, set up each customer for which FedEx will be used as the shipper. To do this, perform the following substeps:

      1. On the Ship-To tab, enter a FedEx shipper you created in step 3 in the Shipper ID field.

      2. Click the Lookup button to the right of the Freight Collection field, and select a freight collection method that corresponds to the payment method entered for the shipper in step 3h.

      3. If you selected Freight Collect, 3rd Party Billing, or Consignee Billing in substep b, enter the customer's FedEx account number in the Shipping Account ID field.

      4. Verify that a phone number is entered for the ship-to address in the Telephone field.

    Note For more information on integrating with FSMS, refer to the FedEx Transaction Coding Reference.

    Note FedEx does not support using Remote Desktop to access the FSMS system.

    Cloud-Based UPS Integration Service Codes

    The following table provides examples of UPS services and service indicators for cloud-based UPS integration.

    UPS Service

    Service Indicator

    Next Day Air

    01

    2nd Day Air

    02

    Ground

    03

    Express

    07

    Expedited

    08

    UPS Standard

    11

    3 Day Select

    12

    Next Day Air Saver

    13

    Next Day Air Early AM

    14

    Express Plus

    54

    2nd Day Air AM

    59

    UPS Saver

    65

    UPS SurePost Less than 1 lb

    92

    UPS SurePost 1 lb or Greater

    93

    UPS SurePost BPM

    94

    UPS SurePost Media

    95