API Reference | ReDoc

Time in Transit

The Time In Transit API provides estimated delivery times for various UPS shipping services, between specified locations.

Key Business Values:

  • Enhanced Customer Experience: Allows businesses provide accurate delivery estimates to their customers, enhancing customer service.
  • Operational Efficiency: Helps in logistics planning by providing transit times for different UPS services.

Reference


Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.

Run In Postman Open in GitHub

TimeInTransit

SecurityOAuth2
Request
path Parameters
version
required
string
Default: "v1"

API Version

header Parameters
transId
required
string

An identifier unique to the request. Length 32

transactionSrc
required
string
Default: testing

Identifies the clients/source application that is calling. Length 512

Request Body schema: application/json

Generate sample code for popular API requests by selecting an example below. To view a full sample request and response, first click "Authorize" and enter your application credentials, then populate the required parameters above and click "Try it out".

<= 1
originCountryCode
required
string = 2 characters <= 1

The country code of the origin shipment. Valid Values: Must conform to the ISO-defined, two-letter country or territory codes. Refer to Country or Territory Codes in the Appendix above for valid values.

originStateProvince
string [ 1 .. 50 ] characters <= 1

The shipment origin state or province. For U.S. addresses, the value must be a valid 2-character value (per U.S. Mail standards) For non-U.S. addresses the full State or Province name should be provided.

originCityName
string [ 1 .. 50 ] characters <= 1

The shipment origin city. Required for International requests for those countries that do not utilize postal codes.

originTownName
string [ 1 .. 50 ] characters <= 1

The shipment origin town. Town is a subdivision of city.

originPostalCode
string [ 1 .. 10 ] characters <= 1

Required for Domestic requests. The shipment origin postal code.
Either the 5, or 9-digit US zip codes must be used for U.S. addresses. For non-U.S. addresses, this is recommended for all countries that utilize postal codes.

destinationCountryCode
string = 2 characters <= 1

The country code of the destination.
Valid values: Must conform to ISO-defined country codes.

destinationStateProvince
string [ 1 .. 50 ] characters <= 1

The shipment destination state or province. For U.S. addresses, the value must be a valid 2-character value (per U.S. Mail standards).
For non-U.S. addresses the full State or Province name should be provided.

destinationCityName
string [ 1 .. 50 ] characters <= 1

The shipment destination city. Required for International Requests for those countries that do not utilize postal codes.

destinationTownName
string [ 1 .. 50 ] characters <= 1

The shipment destination town. Town is a subdivision of city.

destinationPostalCode
string [ 1 .. 10 ] characters <= 1

The shipment destination postal code.
Required for Domestic requests. Either 5, or 9-digit U.S. zip codes must be used for U.S. addresses. For non-U.S. addresses, this is recommended for all countries that utilize postal codes.

residentialIndicator
string = 2 characters <= 1

Indicates if address is residential or commercial. Required for Domestic requests.

Valid values: "01", "02"

01 = Residential 02 = Commercial

Defaults to commercial for International Requests.

shipDate
string [ 1 .. 10 ] characters <= 1

The date the shipment is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS). Allowed range is up to 60 days in future and 35 days in past. This date may or may not be the UPS business date.

Format is YYYY-MM-DD.

YYYY = 4 digit year;

MM = 2 digit month, valid values 01-12;

DD = 2 digit day of month, valid values 01-31 If no value is provided, defaults to current system date.

shipTime
string [ 1 .. 8 ] characters <= 1

The time the shipment is tendered to UPS for shipping (can be dropped off at UPS or picked up by UPS).
Format is HH:MM:SS

Defaults to current time if not provided.

weight
number [ 1 .. 8 ] characters <= 1

The weight of the shipment. Required for International requests.

Note: If decimal values are used, valid values will be rounded to the tenths.

Note: Maximum value is 70 kilograms or 150 pounds.

weightUnitOfMeasure
string [ 1 .. 3 ] characters <= 1

Required for International requests and when weight value is provided.

Valid Values: "LBS", "KGS"

shipmentContentsValue
number [ 1 .. 11 ] characters <= 3

The monetary value of shipment contents.

Required when origin country does not equal destination country and BillType is 03 (non-documented) or 04 (WWEF)

Required when origin country does not equal destination country, and destination country = CA, and BillType = 02 (document).

Note: If decimal values are used, valid values will be rounded to the tenths.

shipmentContentsCurrencyCode
string [ 1 .. 3 ] characters <= 1

The unit of currency used for values. Required if ShipmentContentsValue is populated. Valid value: must conform to ISO standards.

billType
string = 2 characters <= 1

Required for International Requests. Valid values: "02","03","04" 02 - Document 03 - Non Document 04 - WWEF (Pallet)

avvFlag
boolean <= 1

Used to bypass address validation when the address has already been validated by the calling application.

Valid values: true, false

Defaults to true Note: not to be exposed to external customers.

numberOfPackages
integer <= 1

Sets the number of packages in shipment. Default value is 1.

dropOffAtFacilityIndicator
integer <= 1

Sets the indicator for an international Freight Pallet shipment that is going to be dropped off by shipper to a UPS facility. The indicator is used when the Bill Type is "04".

Valid values: "0", "1".

0 = WWDTProcessIF.PICKUP_BY_UPS 1 = WWDTProcessIf.DROPOFF_BY_SHIPPER

The default value is "0"

holdForPickupIndicator
integer <= 1

Sets the indicator for an international Freight Pallet shipment that is going to be pick-up by consignee in a destination facility. The indicator is used when the Bill Type is "04".

Valid values: "0", "1".

0 = WWDTProcessIF.DELIVERY_BY_UPS 1 = WWDTProcessIf.PICKUP_BY_CONSIGNEE

The default value is "0"

returnUnfilterdServices
boolean <= 1

Used to get back a full list of services - bypassing current WWDT business rules to remove services from the list being returned to clients for US domestic that are slower than UPS Ground.

Default value is false.

maxList
integer <= 1

Sets the limit for the number of candidates returned in candidate list.

Default value is 200.

Responses
200

successful operation

400

Invalid Request

401

Unauthorized Request

403

Blocked Merchant

429

Rate Limit Exceeded

post/shipments/{version}/transittimes
Request samples
application/json
{
  • "originCountryCode": "DE",
  • "originStateProvince": "",
  • "originCityName": "",
  • "originTownName": "",
  • "originPostalCode": "10703",
  • "destinationCountryCode": "US",
  • "destinationStateProvince": "NH",
  • "destinationCityName": "MANCHESTER",
  • "destinationTownName": "",
  • "destinationPostalCode": "03104",
  • "weight": "10.5",
  • "weightUnitOfMeasure": "LBS",
  • "shipmentContentsValue": "10.5",
  • "shipmentContentsCurrencyCode": "USD",
  • "billType": "03",
  • "shipDate": "2019-05-01",
  • "shipTime": "",
  • "residentialIndicator": "",
  • "avvFlag": true,
  • "numberOfPackages": "1"
}
Response samples
application/json
{
  • "validationList": {
    },
  • "destinationPickList": [
    ],
  • "originPickList": [
    ],
  • "emsResponse": {
    }
}
➔ Next to Tracking