Freight Integration Module - ShipStation

Freight Integration Module - ShipStation


Introduction


Please note

* Each individual provider is different and requires different information that must be obtained prior to setting up in print IQ.
* All integration are configurable from one screen in print IQ that is available on the main menu under "Admin->Freight->Freight integration".
* Prior to setting up the integration ensure that the customer has purchased the IQ-Automated-Freight module and the module setting is turned on under settings.
* When the admin screen is accessed using a user with "IQ Admin" privileges:
1. The "Integration" drop-down will display all integrations regardless if they are active or not.
2. When selecting an integration from the drop-down an active flag will show allowing you to make the integration available to the customers.
    (Note: The active flag only shows for "IQ Admin" users and will not show for the customer.)
3. When the customer loads the screen only integrations that have been activated by an "IQ Admin" will show in the list.
* Integration points within print IQ:
  1. Quoting - Polling the API for rates for supplied address and dimensions information.
  2. Consignments - Booking with the carrier.
  3. Consignments - Returning a label via API.
  4. Customer job summary - Live tracking of a shipment.


ShipStation

To configure a site to integrate with ShipStation will require the customer gets an API Key for their account from ShipStation.

The API Base URL will also need to be set.


Validate address will validate the address before creating the consignment.
Enable rating will provide automated freight pricing at quoting stage.


Other information required for setting up the freight integration include:
      Label Type - This determines what file format the labels will be when downloaded from FedEx.
            Options:
                         PDF Portable Document Format,
                                ZPL  Zebra Programming Language, or 
                         PNG Portable Network Image files

                              

ShipStation provides for three configurable reference fields which can be used to pass specific details to the delivery label, depending on the carrier selected.



The selectable settings allow for different references to be selected to be passed to ShipStation to be added to the printed shipping label.
These include:
            Job References (30)
            Customer References (20)
            Base Order Number
            Job / Sales Order Number
            Product / Item Code (SKU)
            Customers PO Number
            Customer Code and
            Customer Name


Of the three selectable reference fields in the Configuration screen, different freight providers have limitations on both the number of references supported along with the maximum size of of the reference fields.

Field

Carrier Mapping

FedEx

UPS

USPS

DHL Express

reference1

Customer Reference

35 chars

35 chars

60 chars

35 chars

reference2

Invoice Number

30 chars

35 chars

60 chars

❌ Not supported

reference3

Purchase Order Number

30 chars

❌ Not supported

60 chars

❌ Not supported



Label Display


     • FedEx:              Prefixes the reference values with "REF:", "INV:" or "PO:".





     • UPS:                 Prefixes the reference values with "TRX REF NO.:"



     • USPS:               Does not prefix the references. It displays them at the bottom of the label beneath the barcode


     • DHL Express:  Only uses the first reference ("Customer Reference") and displays it above the waybill barcode

Implementation Notes
• Values are truncated to the most restrictive limits (FedEx) for cross-carrier compatibility

• The 3 source dropdowns in Freight Integration Admin UI map to PrintIQ's standard reference sources (Base Order Number, Job Refs 1-30, Customer Refs 1-20, etc.)

• If a carrier doesn't support a reference field, ShipEngine silently ignores it


    • Related Articles

    • Freight Integration Module - UPS

      Introduction Please note * Each individual provider is different and requires different information that must be obtained prior to setting up in print IQ. * All integration are configurable from one screen in print IQ that is available on the main ...

    • Freight Integration Module - FedEx

      Introduction Please note * Each individual provider is different and requires different information that must be obtained prior to setting up in print IQ. * All integration are configurable from one screen in print IQ that is available on the main ...

    • Automated FedEx and UPS Label Printing

      Introduction Consignment labels from FedEx and / or UPS can be configured to print automatically on ‘download’. After the consignment has been created… Clicking the label file will automatically download it, send it to the printer and delete it from ...

    • Freight Integration with EasyPost

      Snapshot: Customer needs to reach out to individual carrier that they use and ask their account credentials Customer needs to set up individual carrier account that they use in EasyPost. (You need the API key as per the above step to create a carrier ...

    • Shipping Response CSV Import (UPS & FedEx)

      After using the Shipping Export functionality to export delivery details to send to your shipping provider (see KB Article Shipping Export to WorldShip® and Shipping Manager® (UPS & FedEx), you will receive a response from them depicting the tracking ...