Onboard carriers

The data import functionality can be used to quickly and efficiently onboard carriers. All required data must be obtained before performing the import, and converted into one of the supported import file structures. For the imports to succeed, data must be imported in a specific order. If not ordered correctly, the import will fail.

For detail on the file structures required for import, see Database. Additionally, Downloads includes examples for each entity.

Carrier onboarding import

Use data import to onboard carriers using the data entities in the order listed below. Note that the order works on the assumption that Users and Profiles are already configured. See Import Users for detail.

  1. Number Ranges (Package Numbers)
  2. Accounts
  3. Security Credentials
  4. Shipping Keys
  5. Consolidated Shipping Defaults
  6. International Defaults
  7. User Defaults
  8. Outputs
All required fields must be present in the import files for the process to succeed. The required fields for each entity are listed in Database.

API Data Requests

Additionally, certain carriers, outlined in the table below, support requesting security credentials and/or shipping keys from the carriers' own API during the import process. This means these values are not required prior to import.

Configuration

Alongside importing the ordered entities listed above, the following actions are required:

  • The Security Credentials files must have the following fields present but unpopulated: Identifier and Password.
  • The Shipping Keys files must have the following field present but unpopulated: ShippingKeyValue.
  • The following User Defaults elements must be configured:
    • The RequestFromCarrier column must be set to True.
    • All Account (e.g. AccountUserTitle), ShippingLocation (e.g. ShippingLocationAddress1), BillingLocation (e.g. BillingLocationAddress1) and ContactLocation (e.g. ContactLocationAddress1) detail must be populated.

Supported carriers

The following carriers support requesting data from carrier APIs.

Carrier Supported Data Request
FedEx Web Services
  • Security Credentials
  • Shipping Keys
FedEx SmartPost Web Services
  • Security Credentials
  • Shipping Keys
FedEx Freight Web Services
  • Security Credentials
  • Shipping Keys
UPS API
  • Security Credentials
  • Shipping Keys
UPS Freight API
  • Security Credentials
  • Shipping Keys
UPS Freight API
  • Security Credentials
  • Shipping Keys
PB Shipping API - USPS
  • Shipping Keys
Article last edited 20 July 2018