Set up a carrier

Before they can be used, carriers must be enabled for use and made visible to users. This is done in the Administration App. Most carriers can be setup manually through the Carriers page. This topic covers manual setup in general terms and should be used together with the specific carrier's reference topic which includes its key setup detail. Some carriers have dedicated setup topics, and selected carriers can also be onboarded using the wizard detailed in Setup My Carriers.

Each carrier's reference topic outlines supported functions, services and outputs. See Carriers for a list of supported carriers and links to their reference topics (and, if available, dedicated setup topics).

The first-level bullets show the typical setup stages. Indented bullets show possible or optional steps within a stage.

Each of these stages is outlined below. Each carrier's reference topic provides specific information and, if required, points out any significant details or requirements for that carrier.

Requirements

Each carrier has requirements that must be met or understood before it can be enabled in the Administration App. Typically, accounts must exist, and you may require shipping keys or security credentials. Each carrier's reference topic lists these requirements, and generally, if there is a requirement, it means that the relevant step applies to you.

Enable the carrier

  1. In the Administration App, click Carriers.
  2. In the list of carriers, double-click the carrier.
  3. Select Enable, and ensure Display in Carrier Selection Controls is selected.
  4. If required, add or request Security Credentials. The Security Credentials tab is tailored for the selected carrier.
  5. Click SAVE & CLOSE.

See Carriers for more details on this page in the Administration App.

Add the Account

  1. In the Administration App, click Carriers, and then click Accounts.
  2. Click + ADD ACCOUNT.
  3. Enter an Account Name.
  4. Enter your Account Number.
  5. In the Carrier list, select the carrier.
  6. If required, under Shipping Keys for Account, complete the detail, and click ADD NEW. If successful, a row is added. Click SAVE & CLOSE.

See Carriers for more details on this page in the Administration App.

Add Carrier Permissions

  1. In the Administration App, click Carriers, and then click Carrier Permissions.
  2. Click + ADD CARRIER PERMISSION.
  3. In the Carrier list, select the carrier.
  4. In the Security Credentials, Shipping Key and Account lists, select any you added for the carrier.
  5. Under Permissions, select who can use this carrier and account, and click SAVE & CLOSE.

See Carrier Permissions for more details.

Set up Outputs

  1. Click Outputs, and then Labels or Documents, and select + ADD LABEL or + ADD DOCUMENT.
  2. Complete the configuration based on the detail in the carrier's reference topic, and click SAVE & CLOSE.

See Outputs for more details on this page in the Administration App.

Article last edited 28 January 2019