UPS （预览版）
联合包裹服务（UPS）为世界各地的客户和企业提供了广泛的运输、电子商务和商业服务组合。 连接到 UPS API 以验证地址、搜索位置、创建发货、跟踪发货等。
此连接器在以下产品和区域中可用：
| Service | Class | 区域 |
|---|---|---|
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 ： - Azure Government区域 - Azure中国区域 - 美国国防部（DoD） |
| 联系人 | |
|---|---|
| 名称 | Microsoft Dynamics |
| URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| 连接器元数据 | |
|---|---|
| 发布者 | Microsoft |
| 网站 | https://www.ups.com/us/en/services/technology-integration.page |
| 隐私策略 | https://www.ups.com/us/en/help-center/legal-terms-conditions/privacy-notice.page |
| 类别 | 生产力 |
联合包裹服务（UPS）连接器已专门开发，用于 Dynamics 365 智能订单管理提供商集成。
先决条件
- 从 https://www.ups.com/upsdeveloperkit?loc=en_US中注册 UPS.com 配置文件。
如何获取凭据
- Access https://www.ups.com/upsdeveloperkit?loc=en_US。
- 登录以连接到帐户。
- 使用“请求访问密钥”生成访问密钥。
- UPS.Com 配置文件登录用户名、密码和生成的访问密钥将是所需的凭据。
连接器入门
按照以下步骤 https://docs.microsoft.com/en-us/dynamics365/intelligent-order-management/work-providers#set-up-a-provider 启用 UPS 提供程序。
已知问题和限制
此连接器已专门开发，用于 Dynamics 365 Intelligent Order Management 的 UPS 提供程序集成。 对 Dynamics 365 智能订单管理之外的用例的支持将受到限制。
正在创建连接
连接器支持以下身份验证类型：
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用：所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。
| 名称 | 类型 | 说明 | 必需 |
|---|---|---|---|
| 环境：沙盒或生产 | 字符串 | UPS 沙盒环境或生产环境 | 真 实 |
| 访问密钥 | securestring | 通过 UPS 载入过程获取的访问密钥 | 真 实 |
| 用户名 | 字符串 | MyUPS 帐户的用户名 | 真 实 |
| 密码 | securestring | MyUPS 帐户的密码 | 真 实 |
| 事务源 | 字符串 | 标识正在调用的客户端/源应用程序 | 真 实 |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 创建发货 |
创建发货 API 为应用程序提供了多种管理将包裹寄送到其目的地的方法。 |
| 取消发货 |
取消发货 API 用于取消以前计划的发货。 |
| 地址验证街道级别 |
地址验证街道级别 API 可用于检查美国邮政服务数据库中有效地址在美国和波多黎各的地址。 |
| 定位 |
定位器 API 提供 UPS 完整服务和自助服务位置、操作时间和取件时间。 |
| 跟踪 |
跟踪 API 支持包裹、地面货运和航空货运。 |
创建发货
创建发货 API 为应用程序提供了多种管理将包裹寄送到其目的地的方法。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
事务 ID
|
transid | True | string |
请求唯一的标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Code
|
ShipmentResponse.Response.ResponseStatus.Code | string |
标识事务的成功或失败。 |
|
说明
|
ShipmentResponse.Response.ResponseStatus.Description | string |
描述响应状态代码。 返回 Success 的文本。 |
|
警报
|
ShipmentResponse.Response.Alert | ||
|
CustomerContext
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
客户提供的数据。 可以是 XML。 如果请求中存在此数据，则会将其回显给客户。 |
|
TransactionIdentifier
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
请求唯一的标识符。 |
|
免责声明
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
货币代码
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
BaseServiceCharge 货币代码类型。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
基本服务费用金额。 |
|
货币代码
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
运输费用货币代码类型。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
运输和附加费值金额。 |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
货币代码
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
访问器费用货币代码类型。 将返回发货请求中使用的货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
访问器费用值金额。 |
|
TaxCharges
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
货币代码
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
总费用货币代码类型。 将返回发货请求中使用的货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
总费用值金额。 |
|
货币代码
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes 货币代码类型。 将返回发货请求中使用的货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes 货币值金额。 |
|
ItemizedCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
TaxCharges
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
货币代码
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
总费用货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
总费用货币价值。 |
|
货币代码
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes 货币代码类型。 将返回发货请求中使用的货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
TotalChargesWithTaxes 货币值金额。 |
|
货币代码
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
总费用货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
总费用货币价值。 |
|
货币代码
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
折扣金额货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
折扣金额货币值。 |
|
货币代码
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
净费用货币代码。 |
|
MonetaryValue
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
净费用货币价值。 |
|
密度
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
如果发货人有资格获得基于密度的费率，则会返回密度。 |
|
TotalCubicFeet
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
如果运货商有资格获得基于密度的费率，将返回总立方英尺。 |
|
HandlingUnits
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
RatingMethod
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
RatingMethod 用于指示发货是分级为发货级别还是包裹级别。 仅当 Request 中存在 RatingMethodRequestedIndicator 时，才会返回此信息。 有效值：01 = 发货级别 02 = 包裹级别。 |
|
BillableWeightCalculationMethod
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
BillableWeightCalculationMethod 是指示使用的可计费权重计算方法是 - 包级别还是发货级别。 仅当 Request 中存在 RatingMethodRequestedIndicator 时，才会返回此信息。 |
|
Code
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
计费权重度量单位的代码。 值为：KGS 或 LBS。 |
|
说明
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
计费权重度量单位的说明。 |
|
重量
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
计费权重。 实际发货重量与发货维度重量的更高。 |
|
ShipmentIdentificationNumber
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
退回了发货中第一个包裹的 UPS 发货 ID 号.1Z 号。 |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey 是处理邮件创新双重退货的唯一关键。 |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
在接受阶段传递所需的编码发货参数。 仅适用于 ShipConfirmResponse。 |
|
PackageResults
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Code
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
高值报表图形图像类型的代码。 |
|
说明
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
格式代码的说明。 |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Base 64 编码的 html、EPL2、ZPL 或 SPL 映像。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Code | string |
指示窗体类型的代码。 仅适用于 ShipResponse 和 ShipAcceptResponse。 有效值：01 - 所有请求的国际表单。 |
|
说明
|
ShipmentResponse.ShipmentResults.Form.Description | string |
指示窗体类型的说明。 可能的值。 所有请求的国际表单。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
表示生成窗体的格式的代码。 仅适用于 ShipResponse 和 ShipAcceptResponse。 有效值：PDF = 仅 pdf。 |
|
说明
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
表单图像格式代码的说明。 |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Base 64 编码的国际表单图像。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
FormGroupId
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
用于以后检索已保存版本的已完成国际表单的唯一 ID。 当代码 = 01 时始终返回。 01 表示国际形式。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
包含标识国际表单组的说明文本。 此元素是请求和响应的一部分。 此元素不会显示在窗体上。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
设置生成的 COD 轮入页的格式代码。 有效值：HTML = HTML 格式。 COD 轮入页面仅支持 HTML 格式。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
说明
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
生成 COD 轮入页的格式代码的说明。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Base 64 编码的 html 浏览器图像呈现软件。 仅适用于 ShipResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
表示生成高值报表的格式的代码。 有效值：PDF = pdf。 |
|
说明
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
图像格式的说明。 |
|
GraphicImage
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Base 64 编码的 PDF 图像。 |
|
LabelURL
|
ShipmentResponse.ShipmentResults.LabelURL | string |
URL 将指向一个页面，其中标签、收据和其他文档（如果适用），例如 HighValueReport、CustomsInvoice 和 ImportControl 指令可以请求。 仅当请求 LabelLinksIndicator 进行以下发货时才会返回 LabelURL：Print/Electronic ImportControl 发货、打印/电子、退货、转发发货，邮件创新转发除外。 |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
URL 将指向一个页面，其中标签、收据和其他文档（如果适用），例如 HighValueReport、CustomsInvoice 和 ImportControl 指令可以请求。 仅当请求 LabelLinksIndicator 进行以下发货时，才返回 LocalLanguageLabelURL：Print/Electronic ImportControl 发货、打印/电子退货、转发发货，邮件创新转发除外，如果未使用 Locale 元素请求 LabelLinksIndicator，则不返回。 |
|
ReceiptURL
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
URL 将指向一个页面，其中标签、收据和其他文档（如果适用），例如 HighValueReport、CustomsInvoice 和 ImportControl 指令可以请求。 仅当请求 LabelLinksIndicator 进行以下发货时，才返回 ReceiptURL：Print/Electronic ImportControl 发货、打印/电子退货。 |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
URL 将指向一个页面，其中标签、收据和其他文档（如果适用），例如 HighValueReport、CustomsInvoice 和 ImportControl 指令可以请求。 仅当请求 LabelLinksIndicator 进行以下发货时，才返回 LocalLanguageReceiptURL：Print/Electronic ImportControl 发货、打印/电子退货、邮件创新转发除外的转发发货，如果未使用 Locale 元素请求 LabelLinksIndicator，则不会返回。 |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous 良好纸张图像（PDF 格式）。 将返回一个多页 PDF 文档，其中包含所有危险品包裹的所有必需的 Dangrous 商品发货纸副本。 仅当存在 DGSignatoryInfo 时返回。 |
|
MasterCartonID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
主纸箱 ID。 如果 MasterCartonIndicator 在请求中存在，则 MasterCartonID 将返回。 |
取消发货
取消发货 API 用于取消以前计划的发货。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
发货标识号
|
shipmentidentificationnumber | True | string |
发货的标识号。 |
|
跟踪号
|
trackingnumber | string |
包的跟踪编号。 |
|
|
事务 ID
|
transid | True | string |
请求唯一的标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Code
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
标识事务的成功或失败。 |
|
说明
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
描述响应状态代码。 返回 Success 的文本。 |
|
CustomerContext
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
客户提供的数据。 可以是 XML。 如果请求中存在此数据，则会将其回显给客户。 |
|
TransactionIdentifier
|
VoidShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
请求唯一的标识符。 |
|
Code
|
VoidShipmentResponse.SummaryResult.Status.Code | string |
摘要结果状态的代码。 |
|
说明
|
VoidShipmentResponse.SummaryResult.Status.Description | string |
摘要结果的状态说明。 |
|
Code
|
VoidShipmentResponse.PackageLevelResult.Status.Code | string |
摘要结果状态的代码。 |
|
说明
|
VoidShipmentResponse.PackageLevelResult.Status.Description | string |
摘要结果的状态说明。 |
|
TrackingNumber
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
包的标识号。 |
地址验证街道级别
地址验证街道级别 API 可用于检查美国邮政服务数据库中有效地址在美国和波多黎各的地址。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
请求选项
|
requestoption | True | integer |
地址验证请求的请求选项。 |
|
区域请求指示器
|
regionalrequestIndicator | string |
地址验证请求的区域请求指示器。 |
|
|
候选列表大小上限
|
maximumcandidatelistsize | integer |
地址验证请求的最大候选列表大小。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Code
|
XAVResponse.Response.ResponseStatus.Code | string |
系统返回的警告代码。 |
|
说明
|
XAVResponse.Response.ResponseStatus.Description | string |
从系统返回的消息。 |
|
ValidAddressIndicator
|
XAVResponse.ValidAddressIndicator | string |
查询找到有效的匹配项。 |
|
AmbiguousAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
指示查询无法根据提供的信息找到匹配项。 |
|
NoCandidatesIndicator
|
XAVResponse.NoCandidatesIndicator | string |
找不到候选项。 |
|
Code
|
XAVResponse.AddressClassification.Code | string |
包含输入地址的分类代码。 |
|
说明
|
XAVResponse.AddressClassification.Description | string |
包含地址分类代码的文本说明。 |
|
候选
|
XAVResponse.Candidate |
定位
定位器 API 提供 UPS 完整服务和自助服务位置、操作时间和取件时间。
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
CustomerContext
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
客户提供的数据。 可以是 XML。 如果请求中存在此数据，则会将其回显给客户。 |
|
XpciVersion
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
标识消息的版本。 |
|
响应状态码
|
LocatorResponse.Response.ResponseStatusCode | string |
标识交换的成功或失败。 |
|
ResponseStatusDescription
|
LocatorResponse.Response.ResponseStatusDescription | string |
描述响应状态代码。 |
|
ErrorSeverity
|
LocatorResponse.Response.Error.ErrorSeverity | string |
描述错误的严重性。 |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
描述错误的数值。 |
|
错误描述
|
LocatorResponse.Response.Error.ErrorDescription | string |
描述错误代码。 |
|
MinimumRetrySeconds
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
等待等待的秒数，直到重试。 |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
错误的元素的 Xpath 名称。 这是指向请求文档中的元素的有效 Xpath。 |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
错误属性的名称。 这是 Error Location 元素包含的属性的名称。 |
|
ErrorDigest
|
LocatorResponse.Response.Error.ErrorDigest | string |
错误的元素的内容。 |
|
纬度
|
LocatorResponse.Geocode.Latitude | string |
源地址的纬度、交换中心点、邮政编码中心点或城市中心点。 |
|
经度
|
LocatorResponse.Geocode.Longitude | string |
源地址的经度、交换中心点、邮政编码中心点或城市中心点。 |
|
GeocodeCandidate
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
免责声明
|
LocatorResponse.SearchResults.Disclaimer | string |
免责声明。 如果用户请求了地面和空中服务类型和未满足最大 UPS 位置列表大小，则位置列表将继续提供搜索半径内的地面或空气的位置。 |
|
DropLocation
|
LocatorResponse.SearchResults.DropLocation | ||
|
编号
|
LocatorResponse.SearchResults.MapNavigation.Number | string |
放置位置的中心编号（如果为 UPS 存储）。 |
|
高度
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Height | string |
请求中提供的值将返回，否则将重新打开图像的默认宽度设置为 200 像素。 其他有效值介于 100 和 400 之间。 |
|
宽度
|
LocatorResponse.SearchResults.MapNavigation.MapDimensions.Width | string |
请求中提供的值将返回，否则将重新打开图像的默认宽度设置为 200 像素。 其他有效值介于 100 和 400 之间。 |
|
ZoomFactor
|
LocatorResponse.SearchResults.MapNavigation.ZoomFactor | string |
图片必须显示所有 UPS 位置的因素。 |
|
PanX
|
LocatorResponse.SearchResults.MapNavigation.PanX | string |
用户希望平移在 X 轴上的级别。 从不返回。 在初始响应之后，用户可能希望进一步向左或向右查看图像。 为此，需要另一个请求，其值为 1、0 或 1。 |
|
PanY
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
用户希望平移在 Y 轴上的级别。 默认值为 0 的初始请求。 在初始响应之后，用户可能希望进一步向上或向下查看 y 轴的图像。 为此，需要另一个请求，值为 1、0 或 1。 |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
MapID 中已加密 5 个位置 ID 的列表，用于映射生成。 |
|
MapURL
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
一个指向地图的链接，其中包含五个 UPS 位置和 MapID 中指定的原点。 |
|
LocationID
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
特定 UPS 位置的位置 ID。 |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
UPS 位置的 X 坐标。 |
|
YCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.YCoordinate | string |
UPS 位置的 Y 坐标。 |
|
细分市场
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Segment | string |
从源到指定位置的分步说明。 |
|
价值
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.Value | string |
从原点到 UPS 位置的计算距离。 |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Code | string |
度量代码的距离单位。 返回搜索请求中使用的度量单位。 返回的值为：MI-Miles。 |
|
说明
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Distance.UnitOfMeasurement.Description | string |
可以返回请求中指定的度量单位的说明。 有效值为：英里和公里。 |
|
时间
|
LocatorResponse.SearchResults.DrivingDirections.Directions.Time | string |
从原点到位置的驱动器所需的总估计时间段。 |
|
价值
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.Value | string |
从原点到 UPS 位置的直线距离。 |
|
Code
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Code | string |
度量代码的距离单位。 返回搜索请求中使用的度量单位。 返回的值为：MI-Miles。 |
|
说明
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
可以返回请求中指定的度量单位的说明。 有效值为：英里和公里。 |
|
TotalTime
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
从原点到位置的驱动器所需的总估计时间段。 格式：HHMM。 |
|
AvailableLocationAttributes
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
指示国家或地区是否具有 AccessPoint。 |
|
AllowAllConfidenceLevels
|
LocatorResponse.AllowAllConfidenceLevels | string |
指示符，允许搜索中的置信度。 |
跟踪
跟踪 API 支持包裹、地面货运和航空货运。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
查询编号
|
inquiryNumber | True | string |
用于访问 UPS 跟踪信息的查询编号。 |
|
事务 ID
|
transid | True | string |
请求唯一的标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
发货
|
trackResponse.shipment | array of object |
包含与查询编号关联的发货详细信息的元素。 |
|
包
|
trackResponse.shipment.package | array of object |
包含包详细信息的元素。 |
|
trackingNumber
|
trackResponse.shipment.package.trackingNumber | string |
小型包裹、邮件创新、货运或隔夜跟踪号码。 |
|
deliveryDate
|
trackResponse.shipment.package.deliveryDate | ||
|
类型
|
trackResponse.shipment.package.deliveryTime.type | string |
指示传递的类型。 |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
开始时间、提交时间或传递时间。 |
|
结束时间
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
窗口的结束时间。 |
|
活动
|
trackResponse.shipment.package.activity | array of object |
包含与查询编号关联的扫描活动的容器元素。 |
|
位置
|
trackResponse.shipment.package.activity.location | ||
|
类型
|
trackResponse.shipment.package.activity.status.type | string |
活动类型。 |
|
说明
|
trackResponse.shipment.package.activity.status.description | string |
状态说明。 |
|
代码
|
trackResponse.shipment.package.activity.status.code | string |
状态代码。 |
|
date
|
trackResponse.shipment.package.activity.date | string |
活动的日期。 |
|
time
|
trackResponse.shipment.package.activity.time | string |
活动的时间。 |