メインコンテンツへスキップ
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(例:usagbr)。有効な値は すべての発送元国を取得 を参照してください。
  • fromPostalCode — 必須、非空。
  • weightdimension1dimension2dimension3 — すべて必須かつ > 0 であること。
  • limit — 任意、上限は 50。省略時は制限なし(レスポンスは利用可能なサービス数で制限されます)。

レスポンスの注意

  • 各エントリは serviceTypeCodeserviceType(表示名)、warehouseId(返品を受け取る Warehouse)、currencyCodefee を含みます。
  • 一覧は当該発送元でアカウントに有効な返品サービスのみに絞り込まれます。空のレスポンスは、当該発送元で当該サイズ/重量に合うサービスがないことを意味します。
  • 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