ホーム > 送料の虎Webサービス
本サービスは国内の主要な宅配便、メール便サービスの価格情報を提供します。
本サービスは現在、非商用の利用においては無償でご利用いただけます。
申し訳ございません。現在サービスを休止しております。
リクエスト先のURLは下記の通りです。
国内宅配便/メール便送料検索: http://www.shipping.jp/api/FeeCalc/domestic/v1
| パラメータ名 | 必須 | 単位 | 用途 |
|---|---|---|---|
| user | ○ | - | shipping.jp API の利用者ID。利用者登録時に配布されます。 デモ用の利用者IDについてはデモ用のAPI認証キーをご参照ください。 |
| remote_ip | ○ | 有効なIPアドレス(ipv4/6) | エンドユーザーのIPアドレス(現在のところ有効なipv4アドレスにのみ対応。) |
| x | ○ | センチメートル(cm) | 荷物の幅の長さ (0.1 ～ 99999.9) |
| y | ○ | センチメートル(cm) | 荷物の奥行きの長さ (0.1 ～ 99999.9) |
| z | ○ | センチメートル(cm) | 荷物の高さの長さ (0.1 ～ 99999.9) |
| weight | ○ | グラム(g) | 荷物の重量 |
| from | ○ | 荷物の差出地 | 荷物の差出地となる都道府県コード |
| to | ○ | 荷物の仕向地 | 荷物の仕向地となる都道府県コード |
| Dx | ○ | 1 (固定値) | 検索対象となるサービスのID。値は必ず 1 である必要があります。 |
| レベル | タグ名 | 名前 | 目的 |
|---|---|---|---|
| 1 | logo | クレジット用画像 | 本APIを利用する際に掲示いただく画像です。本要素のsrc属性のURLを画像として 利用してください。*1 |
| 1 | query | 検索クエリ | |
| 2 | size | 大きさ | |
| 3 | x | 幅 | 検索を行った荷物の幅の長さ(cm) |
| 3 | y | 奥行き | 検索を行った荷物の奥行きの長さ(cm) |
| 3 | z | 高さ | 検索を行った荷物の高さの長さ(cm) |
| 2 | weight | 重量 | 検索を行った荷物の重量(g) |
| 1 | services | サービスの一覧 | |
| 2 | service | サービスごとの検索結果 | |
| 3 | id | サービス番号 | 検索を行ったサービスの番号 |
| 3 | fee | 送料 | 検索を行ったサービスの送料(日本円) |
| 4 |
@result-code (fee の属性値) |
送料検索結果 |
当該サービスが利用できる場合に R000 を、 これ以外の場合に結果コードを返す。 |
*1本APIを利用する際にはクレジットを画像として表示し、www.shipping.jpへリンクを張っていただくようにお願いをしております。どうぞよろしくお願いします。
本APIを利用するためには、上記のパラメータのほか、HTTPリクエストに refererヘッダーを付加する必要があります。現在のところ、refererヘッダーを付加せずに動作しますが、今後この仕様は変更される可能性があります。
本APIの呼び出しでは、呼び出し結果に応じてHTTPステータスコードを返します。本APIが返すすべてのHTTPステータスコードについては下記のHTTPステータス/エラーコード一覧をご参照ください。
次の荷物を発送する場合のリクエスト
サイズ: 20 x 12 x 1.2 cm (幅 x 奥行き x 高さ)
重量: 400 g
差出地: 東京都 (JP-13)
仕向地: 北海道 (JP-01)
上記リクエストの場合のレスポンス
|
サービス 番号 |
最大 重量 |
最大 3辺 |
その他 | |
|---|---|---|---|---|
| D1 | 定形外郵便物 | 4kg | 90cm | 長辺60cm以下 |
| D3 | ゆうパック | 30kg | 170cm | - |
| D4 | ヤマト宅急便 | 25kg | 160cm | - |
| D6 | 飛脚宅配便 | 30kg | 160cm | 沖縄から発送は航空便扱い |
| D5 | ペリカン便 | 30kg | 170cm | 急行便は3辺140cm以下 |
| D2 | ゆうメール （旧 冊子小包） | 3kg | 170cm | 冊子とした印刷物及び電磁的記録媒体のみ |
| D30 | ポスパケット | 1kg | - | 34×25×3.5cm以下 |
| D14 | EXPACK500 | 30kg | - | 34×25cmの専用封筒利用 |
| D21 | クロネコメール便 | 1kg | 70cm | 長辺40cm以下, 厚さ2cm以下 |
都道府県コードは ISO 3166-2/JIS X 0401 に従い、割り当てられています。送料の虎 ヘルプに記載の番号と異なりますのでご注意ください。
|
|
| 理由コード | 内容 |
|---|---|
| R000 | 正常回答 |
| R401 | 荷物のサイズ、重量がサービスの利用可能な条件に達していません。 |
| R402 | 荷物のサイズがサービスの利用可能な条件に達していません。 |
| R403 | 荷物の重量がサービスの利用可能な条件に達していません。 |
| R411 | 当該サービスは指定された地域での提供を行っていません。 |
| R421 | 当該サービスは終了しました。当該サービスコードは利用できません。 |
|
HTTP ステータス |
エラーコード | エラー内容 |
|---|---|---|
| 400 | E11001 | 必須パラメータに不足があるため利用できません。 |
| 400 | E11003 | パラメータの値に不正な値が含まれています。 |
| 403 | E80101 ～ E80102 | API認証エラー。キーが不正なため認証を行うことができません。 |
| 503 | E91001 ～ E91003 | 計画停止 |
| 500 | E92001 ～ E92002 | 内部サーバーエラー |
本サイト内にて提供されているデモ用API認証キーは不定期に変更されます。本APIを評価目的、実稼働環境で利用される場合には、お気軽にお問い合わせフォームよりその旨をお伝えください。
デモ用のために本API用キーを利用される場合には次のコードをご利用ください。
デモ用API認証キー: 8e41c77fa2a0e5fc5fc2bea7303b517e1a72f97f
このAPI認証キーは定期的に変更されますのでご注意ください。継続してご利用される場合にはお問い合わせフォームよりその旨をお伝えください。
本APIを利用頂き、ご自身のサイトで利用される際にはレスポンス中のlogo要素中に指定される画像を表記し、www.shipping.jpまでリンクをいただきますようお願いいたします。
1日に5,000件以上の呼び出しを行うことが見込まれる場合には、あらかじめお問い合わせフォームよりその旨をお伝えください。
本サービスはAPI利用規約に基づいてご利用ください。