Setting up and granting access to shipper accounts for API-enabled carriers

Setting up and granting access to shipper accounts for API-enabled carriers

Introduction

To take advantage of SureShip™ API functionality such as rate shopping and tracking number generation, you must setup your company’s shipping carrier accounts. Whether shipping from a single work site or multiple, this information is required to send information directly to and from your ERP application.

This article describes the the forms used to configure shipper accounts with API-enabled carriers, and describes the relationship between work sites, site configurations, carrier accounts, and kiosks.

What is a carrier configuration?

A carrier configuration defines the shipper's account information (login credentials and shipping/billing address) with a shipping carrier. Separate configurations must be set up if your company holds accounts with multiple carriers, or multiple accounts with the same carrier. Once created a carrier configuration can be linked to one or more site configurations.

The related articles below describe the forms used to setup carrier configurations for each API-enabled shipping carrier.

What is a site configuration?

A site configuration is a specific combination of carrier configurations. Site configurations may be attached to one or more kiosks, which helps manage which shipper accounts a work site (or certain work stations within a work site) have access to. Consequently, at least one site configuration must be created for each work site in CloudSuite™ Industrial from which units will be shipped.

Each site configuration allows only one carrier configuration (account) per carrier, though multiple site configurations may be setup for the same work site if different kiosks within the same work site will have access to unique carriers and/or shipper account combinations.

To illustrate the relationship between work sites, site configurations, carrier accounts, and kiosks, the diagram below shows a hypothetical distribution facility (work site) with one FedEx® shipper account and two UPS® shipper accounts shared between four kiosks.


SureShip CSI Site Configuration

The SureShip CSI Site Config form is used to setup specific site configurations. Each configuration receives a unique system-assigned Config ID number, though an optional Description may be set for easy identification.

The Carrier Configurations table determines which API-enabled shipping accounts a work site has access to.

Creating a new site configuration

  1. Click Create a new object in the current collection.
  2. Select the appropriate Site name.


  1. Click Save.

Linking carrier configurations (accounts) to a site configuration

  1. Navigate to the appropriate site configuration record.
  2. Click anywhere inside of the Carrier Configurations table, then click Create a new object in the current collection.
  • Enter a valid API-enabled Carrier code.
Carrier codes can be found on the Carriers form in CloudSuite Industrial.
  • Enter the Config ID number for the appropriate carrier configuration.


  1. Click Save.
For EasyPost account holders only, click EPost Refresh Carriers to refresh carrier definition data.

References and Related Articles

What is an API-enabled carrier?

Setting up kiosks (work stations)

Setting up shipper accounts: FedEx® and FedEx Freight®

Setting up shipper accounts: UPS® and UPS Freight®

Setting up shipper accounts: USPS and Endicia®

Setting up shipper accounts: Old Dominion Freight Line®

Setting up shipper accounts: Estes Express Lines®

Setting up shipper accounts: EasyPost®


    • Related Articles

    • Setting up shipper accounts: EasyPost®

      Introduction This article describes the form used to set up carrier configurations for EasyPost®, which can then be linked to site configurations. Please contact your AIT Business Services account representative for initial setup of these accounts.​ ...
    • Setting up shipper accounts: Estes Express Lines®

      Introduction This article describes the form used to set up carrier configurations for Estes Express Lines®, which can then be linked to site configurations. Please contact your Estes account representative for initial setup of these accounts. ...
    • Setting up shipper accounts: UPS® and UPS Freight®

      Introduction This article describes the form used to set up carrier configurations for UPS® and UPS Freight®, which can then be linked to site configurations. Please contact your AIT Business Services account representative for initial setup of these ...
    • Setting up shipper accounts: FedEx® and FedEx Freight®

      Introduction This article describes the form used to set up carrier configurations for FedEx® and FedEx Freight®, which can then be linked to site configurations. Please contact your AIT Business Services account representative for initial setup of ...
    • Setting up shipper accounts: Old Dominion Freight Line®

      Introduction This article describes the form used to set up carrier configurations for Old Dominion Freight Line®, which can then be linked to site configurations. Please contact your Old Dominion account representative for initial setup of these ...