Advanced Account Setup Instructions for a OnTrac V3 API Account

Ron Dreyfus
|
24 steps
|
2 minutes

Shipwise

HubSpot

To activate the OnTrac V3 API for ShipWise, enable the "Use V3 API" option in the OnTrac account settings. *Please note that access to this API is available only to customers who have been registered with OnTrac for V3 API usage.*

**Account Name** - Enter a unique, descriptive and memorable account name selected by the customer. This name serves as an internal identifier within the ShipWise UI, allowing users to efficiently manage and distinguish between multiple OnTrac accounts. *(required field)* Note that the account name is created by the customer and is not provided by OnTrac.

**Account Number** - Enter the OnTrac account number as provided by the customer. This account number is issued directly to the customer by OnTrac. *(required field)*

**Web Service ID** - This required field contains the Web Service ID assigned by OnTrac. The Web Service ID is used within various OnTrac API endpoint URLs, including address validation, rating, shipping, and tracking operation *URL Sample: https://ws.ontrac.com/Method/ChargeCodes/v3/json/**{WSID}**/{WSKey}* *Example WSID: 634764036ea58d5f55e62db2e8dc310cb3444abc875cacxdf1f89e24e4f2323p*

**Web Service Key** - This required field contains the Web Service ID provided by OnTrac. The Web Service ID is used within various OnTrac API endpoints URLs including address validation, rating, shipping, and tracking operation *URL Sample: https://ws.ontrac.com/Method/ChargeCodes/v3/json/{WSID}/**{WSKey}***

**Customer Branch** - This is a required value assigned by OnTrac that uniquely identifies each shipper warehouse.

**Third Party Billing Account** - If applicable, provide the third-party OnTrac account that will be designated for billing all deliveries managed through this OnTrac account. This field is *NOT* required.

**No Returns Service (NOTS)** - enable this option if the OnTrac customer will not be using any OnTrac return services.

***Pickup Type:*** **None** - If the pickup type is set to "none", all packages must be tendered directly to an OnTrac facility by the customer. **OnTrac** - If the pickup type is set to "OnTrac", all packages will be collected by an OnTrac driver at the shipper’s designated location.

**Tender Pickup/Dropoff Time Zone -** *(required filed)* If the Pickup Type is set to "None," this field specifies the time zone of the OnTrac injection facility where the shipper will deliver packages. If the Pickup Type is set to "OnTrac," this field specifies the time zone of the shipper's warehouse where package collection by an OnTrac driver will occur. The available time zones are: *Pacific Standard Time, Central Standard Time, Mountain Standard Time, and Easter Standard Time.*

**Tender Pickup/Dropoff Time -** *(required filed)* If the Pickup Type is set to "None," this field indicates the specific time of day when the shipper will deliver packages to the designated OnTrac injection facility. If the Pickup Type is set to "OnTrac," this field specifies the time of day when the OnTrac driver will collect packages from the shipper's facility.

**Is Business Address** - signifies that the OnTrac customer's address is a commercial address. This Option only appears if the Pickup Type is "OnTrac".

**Tender At Contact** - Enter the primary contact name for the OnTrac account. This field is required when the Pickup Type is set to "OnTrac."

**Tender At Company** - Enter the company name associated with the OnTrac account. This field is required when Pickup Type is set to "OnTrac" and "Is Business Address" is enabled.

**Tender At Address 1** - Enter the primary address line for the OnTrac customer. This field is required when the Pickup Type is set to "OnTrac."

**Tender At Address 2** - Enter the secondary address line for the OnTrac customer. This field is only appears if the Pickup Type is set to "OnTrac", however it is *NOT* required.

**Tender At Postal Code** - Enter the postal code for the OnTrac customer. This field is required when the Pickup Type is set to "OnTrac."

**Tender At City** - Enter the city for the OnTrac customer. This field is required when the Pickup Type is set to "OnTrac."

**Tender At State/Providence** - Enter the two-character state code for the OnTrac customer. This field is required when the Pickup Type is set to "OnTrac."

**Tender At Country** - Enter the customer's two-character country ISO code for the OnTrac customer. This field is required when the Pickup Type is set to "OnTrac."

**Tender At Phone** - Enter the phone number for the OnTrac customer. This field appears when the Pickup Type is set to "OnTrac", however is not required.

**Tender At Email** - Enter the email address for the OnTrac customer. This field appears when the Pickup Type is set to "OnTrac", however is not required.

**Tender At Special Instructions** - Enter the email address for the OnTrac customer. This field appears when the Pickup Type is set to "OnTrac", however is not required.

**Injection Facility** - Specify the local OnTrac facility where the shipper’s packages will be dropped off, either by the customer or by the OnTrac driver. Multiple injection facilities are available in Arizona, California, Colorado, Florida, Idaho, Illinois, North Carolina, New Jersey, Nevada, Ohio, Tennessee, Texas, Utah, and Washington.