UPS（預覽）
聯合包裹服務（UPS）為全球客戶與企業提供廣泛的運輸、電子商務及商業服務組合。 連接 UPS API 以驗證地址、搜尋地點、建立寄件、追蹤包裹等。
此連接器適用於以下產品和區域：
| Service | Class | Regions |
|---|---|---|
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure中國地區 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | Microsoft動力學 |
| URL | https://aka.ms/iomsupport |
| iomdri@microsoft.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 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 |
| 類別 | Productivity |
United Parcel Service（UPS）連接器專為 Dynamics 365 智慧訂單管理的供應商整合而開發。
先決條件
- 請從 UPS.com 註冊 個人檔案 https://www.ups.com/upsdeveloperkit?loc=en_US。
如何取得認證
- 存取 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 智慧訂單管理的 UPS 供應商整合而開發。 對 Dynamics 365 Intelligent Order Management 以外的使用案例的支援將受到限制。
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有地區 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | 說明 | Required |
|---|---|---|---|
| 環境：沙箱或生產環境 | 字串 | UPS 沙盒環境或生產環境 | 對 |
| 存取鍵 | 安全字串 | 透過 UPS 入職流程取得的存取金鑰 | 對 |
| 使用者名稱 | 字串 | 你的 MyUPS 帳號使用者名稱 | 對 |
| 密碼 | 安全字串 | 你的 MyUPS 帳號密碼 | 對 |
| 交易來源 | 字串 | 識別正在呼叫的客戶端/來源應用程式 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 取消出貨 |
取消運送 API 用於取消先前排定的運送。 |
| 地址驗證街道層級 |
地址驗證街道層級API可用於將地址與美國郵政局在美國及波多黎各有效地址資料庫中進行比對。 |
| 定位器 |
Locator API 提供 UPS 全方位及自助服務地點、營業時間及取件時間。 |
| 建立運送 |
Create Shipment API 為應用程式提供了多種方式來管理包裹運送至目的地。 |
| 追蹤 |
追蹤 API 支援包裹、地面貨運及空運貨運。 |
取消出貨
取消運送 API 用於取消先前排定的運送。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
運輸識別號碼
|
shipmentidentificationnumber | True | string |
貨物識別號碼。 |
|
追蹤號碼
|
trackingnumber | string |
包裹的追蹤號碼。 |
|
|
交易標識碼
|
transid | True | string |
一個請求唯一的識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
VoidShipmentResponse.Response.ResponseStatus.Code | string |
識別交易的成敗。 |
|
說明
|
VoidShipmentResponse.Response.ResponseStatus.Description | string |
描述回應狀態代碼。 返回成功文本。 |
|
客戶情境
|
VoidShipmentResponse.Response.TransactionReference.CustomerContext | string |
客戶提供的資料。 可能是 XML。 如果這些資料存在於請求中，會將其回傳給客戶。 |
|
交易識別碼
|
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 |
摘要結果狀態說明。 |
|
追蹤號碼
|
VoidShipmentResponse.PackageLevelResult.TrackingNumber | string |
包裹的識別號碼。 |
地址驗證街道層級
地址驗證街道層級API可用於將地址與美國郵政局在美國及波多黎各有效地址資料庫中進行比對。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
請求選項
|
requestoption | True | integer |
地址驗證請求的請求選項。 |
|
區域請求指標
|
regionalrequestIndicator | string |
地址驗證請求的區域請求指標。 |
|
|
最大候選人名單規模
|
maximumcandidatelistsize | integer |
地址驗證請求的最大候選名單大小。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
XAVResponse.Response.ResponseStatus.Code | string |
系統回傳警告代碼。 |
|
說明
|
XAVResponse.Response.ResponseStatus.Description | string |
系統回覆訊息。 |
|
有效地址指示器
|
XAVResponse.ValidAddressIndicator | string |
查詢找到有效的匹配。 |
|
AmbiguousAddressIndicator
|
XAVResponse.AmbiguousAddressIndicator | string |
表示根據所提供的資訊，查詢無法找到匹配。 |
|
無候選人指標
|
XAVResponse.NoCandidatesIndicator | string |
未找到候選人。 |
|
Code
|
XAVResponse.AddressClassification.Code | string |
包含輸入位址的分類碼。 |
|
說明
|
XAVResponse.AddressClassification.Description | string |
包含地址分類碼的文字描述。 |
|
候選人
|
XAVResponse.Candidate |
定位器
Locator API 提供 UPS 全方位及自助服務地點、營業時間及取件時間。
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
客戶情境
|
LocatorResponse.Response.TransactionReference.CustomerContext | string |
客戶提供的資料。 可能是 XML。 如果這些資料存在於請求中，會將其回傳給客戶。 |
|
Xpci版本
|
LocatorResponse.Response.TransactionReference.XpciVersion | string |
辨識訊息的版本。 |
|
回應狀態碼
|
LocatorResponse.Response.ResponseStatusCode | string |
識別交流道的成敗。 |
|
回應狀態描述
|
LocatorResponse.Response.ResponseStatusDescription | string |
描述回應狀態碼。 |
|
錯誤嚴重性
|
LocatorResponse.Response.Error.ErrorSeverity | string |
描述錯誤的嚴重程度。 |
|
ErrorCode
|
LocatorResponse.Response.Error.ErrorCode | string |
一個描述錯誤的數值。 |
|
錯誤描述
|
LocatorResponse.Response.Error.ErrorDescription | string |
描述錯誤代碼。 |
|
最小重試秒
|
LocatorResponse.Response.Error.MinimumRetrySeconds | string |
等待重試的秒數。 |
|
ErrorLocationElementName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationElementName | string |
錯誤元素的 Xpath 名稱。 這是一個有效的 Xpath 指向請求文件中的某個元素。 |
|
ErrorLocationAttributeName
|
LocatorResponse.Response.Error.ErrorLocation.ErrorLocationAttributeName | string |
錯誤屬性名稱。 這是錯誤位置元素所包含屬性的名稱。 |
|
錯誤摘要
|
LocatorResponse.Response.Error.ErrorDigest | string |
錯誤元素的內容。 |
|
緯度
|
LocatorResponse.Geocode.Latitude | string |
起點地址的緯度、交換中心點、郵遞區號中心點或城市中心點。 |
|
緯度
|
LocatorResponse.Geocode.Longitude | string |
起點地址的經度、交換中心點、郵遞區號的中心點或城市中心點。 |
|
地理碼候選
|
LocatorResponse.SearchResults.GeocodeCandidate | ||
|
Disclaimer
|
LocatorResponse.SearchResults.Disclaimer | string |
免責聲明。 若用戶申請地面與空中服務類型，且未達到UPS最大地點清單大小，則該地點清單將持續提供搜尋半徑內的地面或空中服務。 |
|
投放位置
|
LocatorResponse.SearchResults.DropLocation | ||
|
Number
|
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 的請求。 |
|
潘尼
|
LocatorResponse.SearchResults.MapNavigation.PanY | string |
使用者希望在Y軸上平移到的高度。 初始請求的預設值為 0。 在初步回應後，使用者可能會希望在 y 軸上方或下方觀看圖片。 為此，需再請求一個值為 1、0 或 1 的請求。 |
|
MapID
|
LocatorResponse.SearchResults.MapNavigation.MapID | string |
MapID 中加密了 5 個位置 ID 以供地圖生成。 |
|
地圖網址
|
LocatorResponse.SearchResults.MapNavigation.MapURL | string |
一個連結到地圖，包含五個UPS地點及MapID中指定的起始地點。 |
|
地點識別
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.LocationID | string |
特定UPS據點的地點ID。 |
|
XCoordinate
|
LocatorResponse.SearchResults.MapNavigation.ImageMap.XCoordinate | string |
UPS位置的X座標。 |
|
Y座標
|
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-英里。 |
|
說明
|
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-英里。 |
|
說明
|
LocatorResponse.SearchResults.DrivingDirections.TotalDistance.Distance.UnitOfMeasurement.Description | string |
可能會回傳請求中指定的單位描述。 有效數值為：英里與公里。 |
|
TotalTime
|
LocatorResponse.SearchResults.DrivingDirections.TotalTime | string |
從起點開車到地點的總預估時間。 格式：HHMM。 |
|
可用位置屬性
|
LocatorResponse.SearchResults.AvailableLocationAttributes | ||
|
ActiveAvailableAccessPointIndicator
|
LocatorResponse.SearchResults.ActiveAvailableAccessPointIndicator | string |
顯示該國家或地區是否有 Access Points。 |
|
允許所有信心等級
|
LocatorResponse.AllowAllConfidenceLevels | string |
使用指標以允許搜尋的信心等級。 |
建立運送
Create Shipment API 為應用程式提供了多種方式來管理包裹運送至目的地。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
交易標識碼
|
transid | True | string |
一個請求唯一的識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Code
|
ShipmentResponse.Response.ResponseStatus.Code | string |
識別交易的成敗。 |
|
說明
|
ShipmentResponse.Response.ResponseStatus.Description | string |
描述回應狀態代碼。 返回成功文本。 |
|
Alert
|
ShipmentResponse.Response.Alert | ||
|
客戶情境
|
ShipmentResponse.Response.TransactionReference.CustomerContext | string |
客戶提供的資料。 可能是 XML。 如果這些資料存在於請求中，會將其回傳給客戶。 |
|
交易識別碼
|
ShipmentResponse.Response.TransactionReference.TransactionIdentifier | string |
一個請求唯一的識別碼。 |
|
Disclaimer
|
ShipmentResponse.ShipmentResults.Disclaimer | ||
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.CurrencyCode | string |
BaseServiceCharge 貨幣代碼類型。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.ShipmentCharges.BaseServiceCharge.MonetaryValue | string |
基本服務費價值。 |
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.CurrencyCode | string |
運輸費用 貨幣代碼類型。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TransportationCharges.MonetaryValue | string |
運輸及附加費價值金額。 |
|
明細收費
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ItemizedCharges | ||
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.CurrencyCode | string |
附加費用 貨幣 代碼類型。 運送請求中使用的貨幣代碼會被回傳。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.ShipmentCharges.ServiceOptionsCharges.MonetaryValue | string |
附加費用的價值金額。 |
|
稅務收費
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TaxCharges | ||
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.CurrencyCode | string |
總費用 貨幣代碼類型。 運送請求中使用的貨幣代碼會被回傳。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalCharges.MonetaryValue | string |
總收費金額。 |
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes 貨幣代碼類型。 運送請求中使用的貨幣代碼會被回傳。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.ShipmentCharges.TotalChargesWithTaxes.MonetaryValue | string |
總費用含稅金額。 |
|
明細收費
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.ItemizedCharges | ||
|
稅務收費
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TaxCharges | ||
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.CurrencyCode | string |
總費用 貨幣代碼。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalCharge.MonetaryValue | string |
總計費是金錢價值。 |
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.CurrencyCode | string |
TotalChargesWithTaxes 貨幣代碼類型。 運送請求中使用的貨幣代碼會被回傳。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.NegotiatedRateCharges.TotalChargesWithTaxes.MonetaryValue | string |
總費用含稅金額。 |
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.CurrencyCode | string |
Gross 收取貨幣代碼。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.GrossCharge.MonetaryValue | string |
總收費是金錢價值。 |
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.CurrencyCode | string |
折扣金額 貨幣代碼。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.DiscountAmount.MonetaryValue | string |
折現金額與貨幣價值。 |
|
貨幣代碼
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.CurrencyCode | string |
淨收費貨幣代碼。 |
|
貨幣價值
|
ShipmentResponse.ShipmentResults.FRSShipmentData.TransportationCharges.NetCharge.MonetaryValue | string |
淨收費是金錢價值。 |
|
密度
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.Density | string |
若托運人符合基於密度的費率資格，密度會被退還。 |
|
總立方英尺
|
ShipmentResponse.ShipmentResults.FRSShipmentData.FreightDensityRate.TotalCubicFeet | string |
若托運人符合基於密度的費率資格，則會退還總立方英尺。 |
|
搬運單元
|
ShipmentResponse.ShipmentResults.FRSShipmentData.HandlingUnits | ||
|
評分方法
|
ShipmentResponse.ShipmentResults.RatingMethod | string |
評分方法用來表示該貨件是被評為出貨層級還是包裹層級。 只有當請求中包含 RatingMethodRequestedIndicator 時，這些資訊才會回傳。 有效數值：01 = 出貨等級 02 = 包裹等級。 |
|
計費權重計算方法
|
ShipmentResponse.ShipmentResults.BillableWeightCalculationMethod | string |
計費重量計算方法用來表示所使用的計費重量計算方法是包裹層級還是出貨層級。 只有當請求中包含 RatingMethodRequestedIndicator 時，這些資訊才會回傳。 |
|
Code
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Code | string |
計費權重測量單位的代碼。 數值為：KGS 或 LBS。 |
|
說明
|
ShipmentResponse.ShipmentResults.BillingWeight.UnitOfMeasurement.Description | string |
計費權重測量單位的說明。 |
|
重量
|
ShipmentResponse.ShipmentResults.BillingWeight.Weight | string |
計費重量。 實際貨重比貨重的尺寸重量要高。 |
|
ShipmentIdentification Number
|
ShipmentResponse.ShipmentResults.ShipmentIdentificationNumber | string |
退回的UPS包裹編號1Z，是該包裹中第一個包裹的編號。 |
|
MIDualReturnShipmentKey
|
ShipmentResponse.ShipmentResults.MIDualReturnShipmentKey | string |
MIDualReturnShipmentKey 是處理郵件創新雙重退回寄件所需的唯一金鑰。 |
|
ShipmentDigest
|
ShipmentResponse.ShipmentResults.ShipmentDigest | string |
接收階段需傳遞編碼的運輸參數。 僅適用於 ShipConfirmResponse。 |
|
套件結果
|
ShipmentResponse.ShipmentResults.PackageResults | ||
|
Code
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Code | string |
高價值報告圖形影像類型的程式碼。 |
|
說明
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.ImageFormat.Description | string |
格式代碼的描述。 |
|
圖形影像
|
ShipmentResponse.ShipmentResults.ControlLogReceipt.GraphicImage | string |
Base 64 編碼的 html、EPL2、ZPL 或 SPL 影像。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Code | string |
代碼中指示表格的類型。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 有效值：01 - 所有國際申請表。 |
|
說明
|
ShipmentResponse.ShipmentResults.Form.Description | string |
說明表格類型。 可能的數值。 所有申請的國際表格。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Code | string |
代表表單產生格式的程式碼。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 有效值：PDF = 僅 pdf。 |
|
說明
|
ShipmentResponse.ShipmentResults.Form.Image.ImageFormat.Description | string |
表單影像格式代碼的描述。 |
|
圖形影像
|
ShipmentResponse.ShipmentResults.Form.Image.GraphicImage | string |
Base 64編碼的國際表單影像。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
FormGroupID
|
ShipmentResponse.ShipmentResults.Form.FormGroupId | string |
唯一身份證，供日後取回已保存的國際表格版本。 當代碼 = 01 時，總是回傳。 01代表國際形態。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
FormGroupIdName
|
ShipmentResponse.ShipmentResults.Form.FormGroupIdName | string |
包含描述文字，識別國際形式類別。 這個元素同時存在於請求和回應中。 此元素不會出現在表格上。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Code | string |
生成的COD交稿頁面格式代碼。 有效值：HTML = HTML 格式。 COD 交繳頁面僅支援 HTML 格式。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
說明
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.ImageFormat.Description | string |
生成的COD交接頁面格式代碼說明。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
圖形影像
|
ShipmentResponse.ShipmentResults.CODTurnInPage.Image.GraphicImage | string |
Base 64 編碼的 HTML 瀏覽器影像渲染軟體。 僅適用於 ShipmentResponse 和 ShipAcceptResponse。 |
|
Code
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Code | string |
代表高價值報告產生格式的程式碼。 有效數值：PDF = pdf。 |
|
說明
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.ImageFormat.Description | string |
圖片格式說明。 |
|
圖形影像
|
ShipmentResponse.ShipmentResults.HighValueReport.Image.GraphicImage | string |
Base 64 編碼 PDF 影像。 |
|
標籤網址
|
ShipmentResponse.ShipmentResults.LabelURL | string |
網址會指向一個頁面，該頁面可請求標籤、收據及其他文件，如 HighValueReport、CustomsInvoice 及 ImportControl 指示。 LabelURL 僅在以下寄件請求 LabelLinksIndicator 時回傳：印刷/電子進口控制寄件、印刷/電子寄件、退回寄件、轉寄寄件（郵件創新轉寄除外）。 |
|
LocalLanguageLabelURL
|
ShipmentResponse.ShipmentResults.LocalLanguageLabelURL | string |
網址會指向一個頁面，該頁面可請求標籤、收據及其他文件，如 HighValueReport、CustomsInvoice 及 ImportControl 指示。 LocalLanguageLabelURL 僅在以下寄件請求 LabelLinksIndicator 時回傳：列印/電子進口控制寄件、列印/電子退回寄件、轉寄寄件（郵件創新除外）、若請求 LabelLinksIndicator 與地點元素時不回傳。 |
|
收據網址
|
ShipmentResponse.ShipmentResults.ReceiptURL | string |
網址會指向一個頁面，該頁面可請求標籤、收據及其他文件，如 HighValueReport、CustomsInvoice 及 ImportControl 指示。 只有當以下運送請求使用LabelLinksIndicator時，才會回傳收據URL：列印/電子進口管制運送、列印/電子退貨運送。 |
|
LocalLanguageReceiptURL
|
ShipmentResponse.ShipmentResults.LocalLanguageReceiptURL | string |
網址會指向一個頁面，該頁面可請求標籤、收據及其他文件，如 HighValueReport、CustomsInvoice 及 ImportControl 指示。 LocalLanguageReceiptURL 僅在以下寄件請求 LabelLinksIndicator 時回傳：列印/電子進口管制寄件、印刷/電子退回寄件、轉寄寄件（Mail Innovations Forward）、若以 Locale 元素請求 LabelLinksIndicator 則不會退回。 |
|
DGPaperImage
|
ShipmentResponse.ShipmentResults.DGPaperImage | string |
Dangrous 優質紙張圖片，PDF格式。 將寄回一份多頁的 PDF 文件，內含所有危險品包裹所需的 Dangrous Goods 運輸紙本。 只有在 DGSignatoryInfo 存在時才會回傳。 |
|
主卡頓ID
|
ShipmentResponse.ShipmentResults.MasterCartonID | string |
主紙箱證件。 如果請求中有 MasterCartonIndicator，MasterCartonID 將會回傳。 |
追蹤
追蹤 API 支援包裹、地面貨運及空運貨運。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
查詢編號
|
inquiryNumber | True | string |
查詢號碼用來存取UPS的追蹤資訊。 |
|
交易標識碼
|
transid | True | string |
一個請求唯一的識別碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
運送
|
trackResponse.shipment | array of object |
包含與查詢號碼相關的出貨細節的元素。 |
|
套件
|
trackResponse.shipment.package | array of object |
包含套件細節的元素。 |
|
trackingNumber
|
trackResponse.shipment.package.trackingNumber | string |
小包裹、郵件創新、貨運或隔夜追蹤號碼。 |
|
交付日期
|
trackResponse.shipment.package.deliveryDate | ||
|
型別
|
trackResponse.shipment.package.deliveryTime.type | string |
表示交付類型。 |
|
startTime
|
trackResponse.shipment.package.deliveryTime.startTime | string |
開始時間、承諾時間或交付時間。 |
|
EndTime
|
trackResponse.shipment.package.deliveryTime.EndTime | string |
窗戶的終結時間。 |
|
活動
|
trackResponse.shipment.package.activity | array of object |
一個包含與 inquiryTNumber 相關掃描活動的容器元素。 |
|
位置
|
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 |
狀態代碼。 |
|
日期
|
trackResponse.shipment.package.activity.date | string |
活動的日期。 |
|
time
|
trackResponse.shipment.package.activity.time | string |
活動的時間。 |