On Time
Overview
OnTime is a US domestic carrier offering basic shipping capabilities for domestic deliveries. It supports multi-piece shipments, limited future-dated shipments, and standard label formats
Onboarding of a On Time Carrier Account
To onboard an ONTIME carrier account, the user needs to possess the following pre-requisites:
- An Account Number
- Address
- Security Credentials Username and Password.
To complete the registration process for the ONTIME carrier account, an API request is initiated, including all the required information. Below, you'll find an example of such a request.
Example ONTIME Registration Request
{
"accountNumber": "19XXX",
"carrierID": "ONTIME",
"description": "ONTIME",
"parameters": {
"username": "OnTimeXXXXX",
"password": "48JNG!ndm$XXXX"
},
"carrierAccountType": "Shipping",
"provisioningType": "API"
}If the request to onboard the ONTIME carrier account is successful, the resulting response will be similar to the provided Sample Response below.
Example ONTIME Registration Response
{
"carrierAccountID": "67BKB93ARXjA",
"description": "ONTIME",
"carrierID": "ONTIME",
"accountNumber": "19XXX",
"parameters": {
"username": "OnTimeXXXX"
},
"carrierAccountType": "Shipping",
"provisioningType": "API",
"permission": {
"permissionByEntity": "",
"permissionByValue": null
}
}On Track supports:
- Us domestic shipments
- Future-dated shipments (up to 7 days)
- Multi-piece shipments (up to 75 pieces)
- Tracking
- Domestic labels and documents
Limitations:
- International shipping not supported
- Returns not supported
- Pickup and manifest workflows not supported
- Void/cancel not supported
- Mailing not supported
- Customs and hazmat not supported
- Rate shopping not supported (Only single-carrier commercial rates are returned)
API Operations for Shipping with On Time
The APIs integrate with On Time through the following operations:
Metadata
Metadata provides information about ONTIME carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.