GET api/TransitTime?User={User}&Pass={Pass}&OriginZip={OriginZip}&DestinationZip={DestinationZip}&PickupDate={PickupDate}

This API is used to calculate the number of business days that it will take to move a shipment from its origin point to its destination. When a pickup date is provided, the results returned will also include the date on which an on-time delivery would take place.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
User

Enter the Logon Code assigned to your account (1-8 characters)

 string

Required
Pass

Enter the Password associated with your Logon Code

 string

Required
OriginZip

Supply the zip code (or postal code) that identifies where the shipment is to be picked up

 string

Required
DestinationZip

Supply the zip code (or postal code) where this shipment is to be delivered

 string

Required
PickupDate

Optionally provide the date on which the pickup is to be made, which (when supplied) will result in the scheduled delivery date to be included in the results returned

 string

Default value is BLANK

Body Parameters

None.

Response Information

Resource Description

Returns the fields associated with the request submitted, plus the number of business days that it will take to affect an on-time delivery. Also included in the results will be the scheduled date for delivery, provided a pickup date was submitted in the initial request.

TransitInfo
NameDescriptionTypeAdditional information
ErrorInfo

This field will be empty (blank) if the API Request was processed with no errors. A non-blank response will describe the issue(s) encountered in processing the request.

string

None.
OriginZip

Reflects the zip code (or postal code) submitted as the origin point for a shipment

string

None.
DestinationZip

Reflects the zip code (or postal code) submitted as the destination point for a shipment

string

None.
PickupDate

(Optional) Specifies the date on which the shipment is picked up. When provided, the API will return the date on which an on-time shipment would be delivered. If not provided, the ScheduledDelivery will not be included in the results.

string

None.
TransitDays

Represents the number of business days (not calendar days) that it will take to deliver the shipment

string

None.
ScheduledDelivery

Provided a Pickup Date was submitted with the API request, this will show the date on which an on-time shipment would be expected to deliver.

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ErrorInfo": "sample string 1",
  "OriginZip": "sample string 2",
  "DestinationZip": "sample string 3",
  "PickupDate": "sample string 4",
  "TransitDays": "sample string 5",
  "ScheduledDelivery": "sample string 6"
}

application/xml, text/xml

Sample: 
<TransitInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DUBLAPI">
  <DestinationZip>sample string 3</DestinationZip>
  <ErrorInfo>sample string 1</ErrorInfo>
  <OriginZip>sample string 2</OriginZip>
  <PickupDate>sample string 4</PickupDate>
  <ScheduledDelivery>sample string 6</ScheduledDelivery>
  <TransitDays>sample string 5</TransitDays>
</TransitInfo>