OnTrac requirements

To ship using OnTrac service methods, you'll first need to configure your account in the Shipium Console. Instructions for doing so are included in this document. OnTrac offers both a legacy SOAP API and a REST API, and Shipium supports both. The Shipium Console accepts both sets of OnTrac credentials, so you’ll see additional optional fields when configuring your account. Your Shipium team member coordinates the move to the REST API.

Configure your OnTrac account with Shipium

To set up an OnTrac account in Shipium, you'll create the carrier account in the Shipium Console and provide the credentials issued to you by OnTrac.

Create an OnTrac carrier account

To begin, navigate to Configure > Fulfillment Contexts and select the fulfillment context where you want to add OnTrac. Go to the Carrier Contracts tab and select Add Contract. Choose OnTrac as the carrier and provide a contract name.

The workflow will guide you through contract details, carrier settings, carrier account, and carrier rates. You can find guidance for other steps in the Carrier Contracts documentation. This step provides instructions for creating the carrier account. You'll provide the following:

• Carrier Account Name. Required. A name to represent this carrier account configuration
• Description. Optional. A description your organization will use to refer to the account
• Cost Center. Optional. A field you can send to carriers in API calls, when supported
• International Shipping. Optional. A dropdown selection for domestic or international shipping for the account; the default is No.
• Return To Address. Optional. The address where undeliverable packages will be returned
• Return To Contact. Optional. The point of contact for return shipments
• OnTrac Account Number. Required. Your OnTrac account number
• OnTrac Web Password. Required. The web password issued to you by OnTrac
• OnTrac Web Service ID. Optional. The Web Service ID issued to you by OnTrac for REST API access
• OnTrac Web Service Secret. Optional. The Web Service Secret issued to you by OnTrac for REST API access
• OnTrac Customer Branch. Optional. The alphanumeric Customer Branch identifier issued to you by OnTrac, specific to the warehouse for this carrier account
• OnTrac Web Service ID Test. Optional. The Web Service ID used for OnTrac REST API access in test mode
• OnTrac Web Service Secret Test. Optional. The Web Service Secret used for OnTrac REST API access in test mode
• OnTrac Customer Branch Test. Optional. The Customer Branch identifier used for OnTrac REST API access in test mode

OnTrac account credentials

OnTrac issues credentials directly to your organization. If you don't yet have OnTrac REST API credentials (Web Service ID, Web Service Secret, and Customer Branch), contact your OnTrac account representative to request them. The Customer Branch identifier is specific to each warehouse, so partners with multiple fulfillment centers will receive a separate Customer Branch per warehouse.

LaserShip Routed Delivery

LaserShip Routed Delivery is configured with its own carrier account and credentials, separate from your OnTrac account.

LaserShip credential requirements

Prior to shipping with LaserShip Routed Delivery, you must create a LaserShip carrier account in the Shipium Console. Follow the steps in Create an OnTrac Carrier Account, but choose LaserShip as the carrier. You’ll provide a Web Service ID, Web Service Key, and Customer Branch for the Fulfillment Center (provided by LaserShip), as well as the critical pull time and injection time, both in UTC (hh:mm).

Customs fields

When shipping with LaserShip Routed Delivery to an international destination or a military (APO/FPO/DPO) address, you must include the three fields listed in the following table as part of the shipmentParameters.

A snippet of the JSON request for the API call with the customs fields is included. This example is for a single-parcel shipment. The request fields for a multi-parcel shipment would be included in multiParcelShipmentParameters.

{
  "shipmentParameters": {
    "customsInfo": {
      "totalCustomsValue": 54.95,
      "totalCustomsValueCurrency": "USD",
      "customsDescription": "9 mm steel screws"
    }
  }
}

Declared value for packages

When shipping with LaserShip Routed Delivery, you may optionally declare a value for the package being shipped by including the fields provided in the table below.

A snippet of the JSON request for the API call with the optional declared value fields is included. This example is for a single-parcel shipment. A multi-parcel shipment request would include these fields in multiParcelShipmentParameters.

{
  "shipmentParameters": {
    "totalDeclaredValue": {
      "declaredValue": 500,
      "currencyCode": "USD"
    }
  }
}

OnTrac service methods

The OnTrac service methods supported by Shipium are listed in the Supported Carriers documentation.

FAQ

Q: What if I don't already have an OnTrac account?
A: You can create a new OnTrac account by contacting OnTrac directly. Once you have an OnTrac account and credentials, you can follow the guidance in this document.

Q: Does Shipium hold a copy of our credentials once entered?
A: Your credentials are stored securely in the Shipium platform and used only to authenticate API calls to OnTrac on your behalf.

Q: What if I don't know my OnTrac credentials?
A: Shipium recommends contacting your OnTrac account representative to request your credentials.

Q: What's the difference between the OnTrac Web Password and the OnTrac Web Service Secret?
A: The OnTrac Web Password authenticates calls to OnTrac's legacy SOAP API. The OnTrac Web Service Secret, paired with the Web Service ID and Customer Branch, authenticates calls to OnTrac's REST API. The Console shows fields for both sets of credentials, and which set your account uses depends on whether it has moved to OnTrac’s REST API.

Q: What happens when I void an OnTrac or LaserShip Routed Delivery label?
A: For accounts that use OnTrac’s REST API, voiding an OnTrac label sends a cancellation request to OnTrac and returns a status indicating success or failure. Because a void can return a failure response, make sure your integration handles void failures appropriately. For accounts that use OnTrac’s legacy API, and for LaserShip Routed Delivery labels, voiding marks the label as voided in Shipium without sending a cancellation request to the carrier.

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

• Terms and Definitions

• Troubleshooting Guide

• Contact Shipium Support