UPS (Preview)
United Parcel Service (UPS) provides customers and businesses worldwide with a broad portfolio of transportation, e-commerce, and business services. Connect to UPS APIs to validate address, search locations, create shipment, track shipments etc.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://www.ups.com/us/en/services/technology-integration.page |
| Privacy policy | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| Categories | Productivity |
United Parcel Service (UPS) connector has been specifically developed to be used for Dynamics 365 Intelligent Order Management's Provider integration.
Prerequisites
- Sign up for UPS.com Profile from https://www.ups.com/upsdeveloperkit?loc=en_US.
How to get credentials
- Access https://www.ups.com/upsdeveloperkit?loc=en_US.
- Log-in to connect to your account.
- Use "Request an Access Key" to generate the Access key.
- UPS.Com Profile Log-in User Name, Password and the generated Access key will be the required credentials.
Getting started with your connector
Follow https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider to enable UPS Provider.
Known issues and limitations
This connector has been specifically developed to be used for Dynamics 365 Intelligent Order Management's UPS Provider integration. Support for use cases outside of Dynamics 365 Intelligent Order Management will be limited.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| Environment: Sandbox or Production | string | UPS Sandbox environment or Production environment | True |
| Access Key | securestring | Access Key obtained through UPS on-boarding process | True |
| Username | string | Username of your MyUPS account | True |
| Password | securestring | Password of your MyUPS account | True |
| Transaction Source | string | Identifies the clients/source application that is calling | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Address Validation Street Level |
Address Validation Street Level API can be used to check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico. |
| Cancel Shipment |
Cancel Shipment API is used to cancel the previously scheduled shipment. |
| Create Shipment |
Create Shipment API gives the application many ways to manage the shipment of packages to their destination. |
| Locator |
Locator API provides UPS full-service and self-service locations, hours of operation and pickup times. |
| Tracking |
Tracking API supports Package, Ground Freight and Air Freight shipments. |
Address Validation Street Level
Address Validation Street Level API can be used to check addresses against the United States Postal Service database of valid addresses in the U.S. and Puerto Rico.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Request Option
|
requestoption | True | integer |
The request option of address validation request. |
|
Regional Request Indicator
|
regionalrequestIndicator | string |
The regional request indicator of address validation request. |
|
|
Maximum Candidate List Size
|
maximumcandidatelistsize | integer |
The maximum candidate list size of address validation request. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code
|
XAVResponse.Response.ResponseStatus.Code | string |
Warning code returned by the system. |
|
Description
|
XAVResponse.Response.ResponseStatus.Description | string |
Message returned from the system. |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
Query found a valid match. |
|
AmbiguousAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
Indicates query could not find a match based on the information provided. |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
No Candidate found. |
|
Code
|
XAVResponse.AddressClassification.Code | string |
Contains the classification code of the input address. |
|
Description
|
XAVResponse.AddressClassification.Description | string |
Contains the text description of the address classification code. |
|
Candidate
|
XAVResponse.Candidate |
Cancel Shipment
Cancel Shipment API is used to cancel the previously scheduled shipment.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Shipment Identification Number
|
shipmentidentificationnumber | True | string |
The shipment's identification number. |
|
Tracking Number
|
trackingnumber | string |
The package's tracking number. |
|
|
Transaction ID
|
transid | True | string |
An identifier unique to the request. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
Identifies the success or failure of the transaction. |
|
Description
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
Describes Response Status Code. Returns text of Success. |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
Customer provided data. May be XML. If this data is present in the request, it is echoed back to the customer. |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
An identifier unique to the request. |
|
Code
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
Code for the status of the Summary Result. |
|
Description
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
Description of the status of the Summary Result. |
|
Code
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
Code for the status of the Summary Result. |
|
Description
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
Description of the status of the Summary Result. |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
The package's identification number. |
Create Shipment
Create Shipment API gives the application many ways to manage the shipment of packages to their destination.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Transaction ID
|
transid | True | string |
An identifier unique to the request. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Code
|
ShipmentResponse.Response.ResponseStatus.Code | string |
Identifies the success or failure of the transaction. |
|
Description
|
ShipmentResponse.Response.ResponseStatus.Description | string |
Describes Response Status Code. Returns text of Success. |
|
Alert
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
Customer provided data. May be XML. If this data is present in the request, it is echoed back to the customer. |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
An identifier unique to the request. |
|
Disclaimer
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
BaseServiceCharge currency code type. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
Base Service Charge value amount. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
Transportation charges currency code type. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
Transportation and surcharges value amount. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
Accessorial charges currency code type. The currency code used in the Shipment request is returned. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
Accessorial charges value amount. |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
Total charges currency code type. The currency code used in the Shipment request is returned. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
Total charges value amount. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes currency code type. The currency code used in the Shipment request is returned. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes monetary value amount. |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
Total charges currency code. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
Total charges monetary value. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes currency code type. The currency code used in the Shipment request is returned. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes monetary value amount. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Gross charges currency code. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
Gross charges monetary value. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
Discount Amount currency code. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
Discount amount monetary value. |
|
CurrencyCode
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
Net Charge currency code. |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
Net charges monetary value. |
|
Density
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
Density is returned if the Shipper is eligible for Density based rate. |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
Total Cubic feet is returned if the Shipper is eligible for Density based rate. |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod is to indicate whether the Shipment was rated as shipment level or package level. This information will be returned only if RatingMethodRequestedIndicator is present in the request. Valid values: 01 = Shipment level 02 = Package level. |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod is to indicate whether the billable weight calculation method utilized was - the package level or shipment level. This information will be returned only if RatingMethodRequestedIndicator is present in the request. |
|
Code
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
Code of the billing weight measurement units. Values are: KGS or LBS. |
|
Description
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
Description of the billing weight measurement units. |
|
Weight
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
Billing weight. Higher of the actual shipment weight versus the shipment dimensional weight. |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
Returned UPS shipment ID number.1Z Number of the first package in the shipment. |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey is unique key required to process Mail Innovations Dual Return Shipment. |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
Encoded shipment parameters required to be passed in the accept phase. Applicable only for ShipConfirmResponse. |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Code
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
Code for the type of Graphic Image for the High Value Report. |
|
Description
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
Description of the format code. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Base 64 encoded html, EPL2, ZPL or SPL image. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Code | string |
Code that indicates the type of form. Applicable only for ShipmentResponse and ShipAcceptResponse. Valid values: 01 - All Requested International Forms. |
|
Description
|
ShipmentResponse.ShipmentResults.Form.Description | string |
Description that indicates the type of form. Possible Values. All Requested International Forms. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
Code representing the format in which the forms are generated. Applicable only for ShipmentResponse and ShipAcceptResponse. Valid value: PDF = pdf Only. |
|
Description
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
Description of the form image format code. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Base 64 encoded International forms image. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
Unique Id for later retrieval of saved version of the completed international forms. Always returned when code = 01. 01 represents international forms. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
Contains description text which identifies the group of International forms. This element is part of both request and response. This element does not appear on the forms. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
Format code of the generated COD Turn In Page. Valid values: HTML = HTML format. Only HTML format is supported for COD Turn In Page. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
Description
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
Description of the format code of generated COD Turn In page. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Base 64 encoded html browser image rendering software. Applicable only for ShipmentResponse and ShipAcceptResponse. |
|
Code
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
Code representing the format in which the High Value Report is generated. Valid values: PDF = pdf. |
|
Description
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
Description of the image format. |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Base 64 Encoded PDF Image. |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LabelURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment, Print/Electronic, Return shipment, Forward shipment except for Mail Innovations Forward. |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LocalLanguageLabelURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment, Print/Electronic Return shipment, Forward shipment except for Mail Innovations Forward, Not returned if LabelLinksIndicator is requested with Locale element. |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. ReceiptURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment, Print/Electronic Return shipment. |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
URL will point to a page wherein label, receipt and other documents, if applicable, such as HighValueReport, CustomsInvoice and ImportControl instructions can be requested. LocalLanguageReceiptURL is returned only if the LabelLinksIndicator is requested for following shipments: Print/Electronic ImportControl shipment, Print/Electronic Return shipment, Forward shipment except for Mail Innovations Forward, Not returned if LabelLinksIndicator is requested with Locale element. |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous Good Paper Image in pdf format. One multipage PDF document will be returned that will contain all required Dangrous Goods shipping paper copies for all Dangerous Goods packages. Only returned when DGSignatoryInfo is present. |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
Master Carton ID. MasterCartonID will be return if MasterCartonIndicator is present in request. |
Locator
Locator API provides UPS full-service and self-service locations, hours of operation and pickup times.
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
Customer provided data. May be XML. If this data is present in the request, it is echoed back to the customer. |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
Identifies the version of the message. |
|
ResponseStatusCode
|
LocatorResponse.Response.ResponseStatusCode | string |
Identifies the success or failure of the interchange. |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
Describes the Response Status Code. |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
Describes the severity of the error. |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
A numeric value that describes the error. |
|
ErrorDescription
|
LocatorResponse.Response.Error.ErrorDescription | string |
Describes the error code. |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
Number of seconds to wait until retry. |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
The Xpath name of the element in error. This is a valid Xpath pointing to an element in the request document. |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
The name of the attribute in error. This is the name of the attribute contained by the Error Location element. |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
The contents of the element in error. |
|
Latitude
|
LocatorResponse.Geocode.Latitude | string |
The latitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. |
|
Longitude
|
LocatorResponse.Geocode.Longitude | string |
The longitude of the origin address, center point of the exchange, center point of the postal code, or center point of the city. |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Disclaimer
|
LocatorResponse.SearchResults.Disclaimer | string |
Disclaimer. In the event the user requested Ground and Air service types and the maximum UPS locations list size has not been met, the list of locations will continue with locations that provide either ground or air within the search radius. |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
Number
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
The center number of the drop location if it is The UPS store. |
|
Height
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
The value provided in the request will be returned, else the default width of the image re-turned is set at 200 pixels. Other valid values are between 100 and 400. |
|
Width
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
The value provided in the request will be returned, else the default width of the image re-turned is set at 200 pixels. Other valid values are between 100 and 400. |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
The factor the picture has to be in order to show all of the UPS locations. |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
The level to which the user wishes to pan on the X-axis. Never returned. Following the initial response the user may wish to view the image further to the left or to the right. To do so another request is required with a value of 1, 0, or 1. |
|
PanY
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
The level to which the user wishes to pan on the Y-axis. The initial request the default value is 0. Following the initial response the user may wish to view the image further up or down the y-axis. To do so another request is required with a value of 1, 0 or 1. |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
A list of 5 Location IDs are encrypted within the MapID for Map generation. |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
A Link to the map with the five UPS locations and the origin location specified in the MapID. |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
The location ID of a particular UPS location. |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
The X coordinate of the UPS location. |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
The Y coordinate of the UPS location. |
|
Segment
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
Step-by-step directions from the Origin to the specified location. |
|
Value
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
The calculated distance from the origin to the UPS location. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
The distance unit of measurement code. The unit of measurement used in the search request is returned. Values returned are: MI-Miles. |
|
Description
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
May return the description of the unit of measure specified in the request. Valid values are: Miles and Kilometer. |
|
Time
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
The total estimated period of time it would take to drive from the origin to the location. |
|
Value
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
The straight line distance from the origin to the UPS location. |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
The distance unit of measurement code. The unit of measurement used in the search request is returned. Values returned are: MI-Miles. |
|
Description
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
May return the description of the unit of measure specified in the request. Valid values are: Miles and Kilometer. |
|
TotalTime
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
The total estimated period of time it would take to drive from the origin to the location. Format: HHMM. |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
Indicates whether the country or territory has AccessPoints or not. |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
Indicator to allow confidence level in search. |
Tracking
Tracking API supports Package, Ground Freight and Air Freight shipments.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Inquiry Number
|
inquiryNumber | True | string |
The inquiry number used to access UPS tracking information. |
|
Transaction ID
|
transid | True | string |
An identifier unique to the request. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
shipment
|
trackResponse.shipment | array of object |
Element which contains the Shipment details associated to the inquiry numbers. |
|
package
|
trackResponse.shipment.package | array of object |
Element which contains the Package details. |
|
trackingNumber
|
trackResponse.shipment.package.trackingNumber | string |
The small package, mail innovations, freight or overnight tracking number. |
|
deliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
type
|
trackResponse.shipment.package.deliveryTime.type | string |
Indicates the type of delivery. |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
The start time, committed time or delivered time. |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
The end time of the window. |
|
activity
|
trackResponse.shipment.package.activity | array of object |
A container element containing the scan activity associated with the inquiryNumber. |
|
location
|
trackResponse.shipment.package.activity.location | ||
|
type
|
trackResponse.shipment.package.activity.status.type | string |
Activity type. |
|
description
|
trackResponse.shipment.package.activity.status.description | string |
Status description. |
|
code
|
trackResponse.shipment.package.activity.status.code | string |
Status code. |
|
date
|
trackResponse.shipment.package.activity.date | string |
The date of the activity. |
|
time
|
trackResponse.shipment.package.activity.time | string |
The time of the activity. |