跳轉到主要內容
GET
/
api
/
Shipment
/
getShippingFeeListByFromShippingOption
Get shipping fees from origin location
curl --request GET \
  --url https://api.returnshelper.com/uat/user/api/Shipment/getShippingFeeListByFromShippingOption \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>'
{
  "data": {
    "shippingFeeDetailList": [
      {}
    ]
  }
}
此頁面由 AI 自動翻譯。API 技術規格以英文呈現為標準。如有任何疑問，請參閱英文版本。
針對指定的起始位置（國家 + 郵遞區號）與包裹尺寸／重量，回傳可用的 Return Service Types 並附帶費用估算。可作為其他 /api/ServiceType/* 查詢的「含費用」對應，在 建立 Return Shipment 之前預覽費用。預覽階段不保證最終費率，但相同輸入通常會在建立 Shipment 時產生相同費用。 此端點公開的是 Return 目錄加上費用。Resend 出庫服務不適用此端點 — 請從 取得 Warehouse 可用的 Shipment Service Types 開始。Resend 費用在建立訂單時決定，無法透過本端點預覽。

​
何時呼叫

  • 為已知尺寸與重量的包裹挑選最便宜的退貨價格。
  • 整合測試時，確認帳戶在指定國家下已開通的退件服務。

​
必要參數

  • fromCountryCode — 必填，小寫 ISO3（例如 usa、gbr）。可用值見 取得所有起始國家。
  • fromPostalCode — 必填，非空。
  • weight、dimension1、dimension2、dimension3 — 全部必填且必須 > 0。
  • limit — 選填，上限 50。省略時不設限制（回應由可用服務數量限制）。

​
回應備註

  • 每筆紀錄包含 serviceTypeCode、serviceType（顯示名稱）、warehouseId（接收退件的 Warehouse）、currencyCode 與 fee。
  • 列表會過濾為該起始位置下您帳戶已授權的退件服務。空回應表示該起始位置下沒有符合該尺寸／重量的服務。
  • chargeableWeight 為承運商實際計費的重量，可能因材積重量進位而高於實際 weight。

授權

​
x-rr-apikey
string
header
必填

Your API key

​
x-rr-apitoken
string
header
必填

Your API token — keep this private

查詢參數

​
fromCountryCode
string
必填

ISO3 origin country code

​
fromPostalCode
string
必填

Origin postal code

​
weight
number<decimal>
必填

Parcel weight

​
dimension1
number<decimal>
必填

Length (longest dimension)

​
dimension2
number<decimal>
必填

Width (second longest dimension)

​
dimension3
number<decimal>
必填

Height (shortest dimension)

​
limit
integer<int32>

Maximum number of results

必填範圍: 0 <= x <= 50

回應

Success

​
data
object

Shipping fee summary