戻る

VibeFox FedEx for OpenCart — ヘルプ

動作要件

OpenCart:3.0.x(3.0.5.0 で動作確認済み)または 4.0.2 以降(4.1.0.3 で動作確認済み)。

PHP:8.0 以降(cURL 拡張機能を含む)。

FedEx アカウントと API キー(リアルタイム料金の場合のみ):FedEx Developer Portal(developer.fedex.com)で、Rate API を有効にしたプロジェクトを作成し、FedEx の発送アカウントを連携させて、API Key と Secret Key をコピーしてください。さらに、9 桁の FedEx アカウント番号も必要です。テスト用のキーは Sandbox をオンにした場合のみ、本番用のキーはオフにした場合のみ使用できます。この拡張機能は OAuth 2.0 を使用する FedEx REST API を利用します。メーター番号やウェブサービスのパスワードは必要ありません。固定料金のみを使う場合、FedEx のキーは不要です。

VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。

インストール

ダウンロードは、両方の OpenCart バージョン用のパッケージを含む 1 つの zip ファイルです。お使いのコンピューターで解凍してください。README.txt、OpenCart 3 用のパッケージ vfd_fedex-oc3-(version).ocmod.zip、OpenCart 4 用のパッケージ vfd_fedex.ocmod.zip が含まれています。お使いの OpenCart バージョンに対応するパッケージのみをインストールしてください。ライセンスキーは両方のバージョンで同じです。

OpenCart 3

1. 管理画面で Extensions > Installer に移動し、Upload をクリックして vfd_fedex-oc3-(version).ocmod.zip を選択します。この拡張機能は OCMOD の変更を追加しないため、Extensions > Modifications を更新する必要はありません。インストーラーの代わりに、このパッケージの upload フォルダの中身をストアのルートフォルダにコピーすることもできます。

2. Extensions > Extensions に移動し、拡張機能の種類として Shipping を選択します。VibeFox FedEx を見つけて、Install(緑の + ボタン)をクリックします。

3. Edit(鉛筆のボタン)をクリックして設定ページを開きます。

4. Edit ページ上部のライセンスブロックにある License key に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーを参照)。

5. API Key、Secret Key、9 桁の FedEx アカウント番号、そして Ship from の住所(郵便番号、および米国とカナダの場合は 2 文字の州コード)を入力します。本番用のキーを使う場合は Sandbox をオフにしてください。必要に応じて、フォールバックとして固定料金を入力します。Enable/Disable をオンにして、Save をクリックします。

OpenCart 4

1. 管理画面で Extensions > Installer に移動し、Upload をクリックして vfd_fedex.ocmod.zip を選択します。ファイル名は変更しないでください。OpenCart 4 は拡張機能のコードをファイル名から取得するため、名前を変更したパッケージは動作しません。

2. パッケージは、同じページのインストール済み拡張機能の一覧に表示されます。その横にある Install(緑の + ボタン)をクリックします。

3. Extensions > Extensions に移動し、拡張機能の種類として Shipping を選択します。VibeFox FedEx を見つけ、Install(緑の + ボタン)をクリックしてから、Edit(鉛筆のボタン)をクリックします。

4. ライセンスキーと設定は、OpenCart 3 の手順 4 と 5 と同じように入力します。設定ページとそのフィールドは両方のバージョンで同じです。

インストール後は、Enable/Disable をオンにして保存するまで配送方法はオフのままです。アンインストール後に拡張機能を再インストールした場合は、保持されていた FedEx の設定が再び使われます。

設定

すべての設定は拡張機能のページにあります:Extensions > Extensions > Shipping > VibeFox FedEx > Edit。セクションは左側に並んでいます。ページ下部の Save ボタンで、ページを再読み込みせずにページ全体を保存できます。保存するたびに、キャッシュされた FedEx のトークンと料金も消去されます。この拡張機能の変更権限を持つ管理者ユーザーのみが設定を保存できます。

ページ上部には、次のような警告が表示されます:3 つの API 認証情報のうち一部しか入力されていない、API キーも固定料金もない(その場合、配送方法は表示されません)、発送元の郵便番号がない、米国またはカナダの発送元の州がない、ストアの通貨に FedEx アカウント通貨の料金用の為替レートがない、kg の重量クラスがない状態で拡張機能が認識しない重量単位がある(System > Localisation > Weight Classes で追加してください)、または箱サイズを設定している場合に認識しない長さの単位がある。数値フィールドは小数点とカンマのどちらも受け付けます。保存時に、無効な数値や箱サイズ、為替レートの 0、3 文字のコードではないアカウント通貨、無効な名前や並び順は通知され、保存されません。その項目は以前の値を保持し、ほかの項目は保存されます(The other settings were saved.)。最小重量が最大重量より大きい場合も通知され、両方の重量は以前の値を保持します。

一般

この設定はすべてのジオゾーンに適用されます。FedEx はチェックアウト時に 1 つの配送オプションとして表示されます。最も安い FedEx サービス、または FedEx から料金が返されない場合の固定料金です。

Enable/Disable:チェックアウト時の FedEx 配送をオンまたはオフにします。デフォルト:オフ。

Name:チェックアウト時に購入者に表示される配送方法の名前。最大 64 文字で、< > ; = # { } は使用できません。デフォルト:FedEx。必須。

Tax class:配送料の税クラス、または No tax(デフォルト)。税クラスを選ぶと、OpenCart は配送料に税を加算するため、税抜きの FedEx の料金が使われます。No tax の場合は、FedEx の正味料金がそのまま使われます。

Sort order:チェックアウト時の配送方法の中での FedEx の位置。整数で指定します。

FedEx API(リアルタイム料金)

このセクションでは FedEx Developer Portal へのリンクがあります。キーがない場合は固定料金が使われます。

Sandbox:テスト用のキーを使って FedEx サンドボックス(apis-sandbox.fedex.com)を利用します。実際の料金(apis.fedex.com)を取得するには、本番用のキーとともにオフにします。デフォルト:オン。

API Key:FedEx Developer Portal のプロジェクトの API Key(client_id)。これを空にすると、保存済みの Secret Key も削除されます。

Secret Key:同じプロジェクトの Secret Key(client_secret)。保存後、このフィールドは空になり、Saved — leave empty to keep it. Clearing the API Key removes it too. と表示されます。値を変更する場合のみ新しい値を入力してください。

FedEx account number:プロジェクトに連携された 9 桁の FedEx 発送アカウント。アカウント(交渉済み)料金は、このアカウントに対して見積もられます。

Rates:Account rates (your negotiated FedEx prices)(デフォルト)または List rates (FedEx published prices)。

Residential delivery:購入者の住所を住宅地として見積もります(FedEx Home Delivery、住宅地の追加料金)。主に法人向けに発送する場合はオフにしてください。デフォルト:オン。

Box size (L x W x H):任意の箱の寸法。フィールド名に示されたストアの長さの単位(例:30x20x15)で入力します。FedEx は容積重量を適用します。重量のみで見積もる場合は空のままにします。

FedEx account currency:FedEx アカウントの通貨(米国のアカウントなら USD、カナダなら CAD など)。デフォルト:USD。FedEx には、ストアのデフォルト通貨でも見積もるよう常に依頼します。

Exchange rate:FedEx がアカウント通貨の料金のみを返し、ストアのデフォルト通貨が異なる場合にのみ必要です。アカウント通貨 1 単位のデフォルト通貨での価格(例:0.92)。これが設定されていない場合、そのような料金は使われず、ほかの通貨の金額が自分の通貨として表示されることもありません。

Cache:Clear cached FedEx token and rates ボタンで、キャッシュを即座に空にできます。FedEx のトークンは期限切れまでキャッシュされ、料金は 1 時間、失敗したリクエストは 5〜10 分間キャッシュされます。

Ship from

FedEx が集荷する、または荷物を持ち込む住所です。リアルタイム料金に使われます。

Country:発送元の国。デフォルト:United States。

State / province code:2 文字の州コード。米国とカナダでは必須です(例:TN、CA、ON)。

City:発送元の都市。

ZIP / postal code:発送元の郵便番号。FedEx が料金を見積もるために必要です。OpenCart にはストアの郵便番号がないため、ここに入力してください。

固定料金

API キーが入力されていない場合に使われ、また FedEx から料金が返されない場合(API の停止、誤ったキー、対応サービスなし)のフォールバックとしても使われます。その場合に配送方法を非表示にするには、両方のフィールドを空のままにしてください。

Country prices:配送先の国と料金の一覧。料金はストアのデフォルト通貨で、税抜きです。Add row をクリックすると行を追加でき、× ボタンで削除できます。独自の行がない国に適用される料金として、* Any other country を選択します。国や料金が無効な行は無視され、保存時に通知されます。

Fallback cost:一致する国別料金がない場合の固定料金。空にすると配送方法は非表示になります。

Fixed price is:Per order(デフォルト)は料金を 1 回だけ請求します。Per item (price x number of items) は、カート内の商品数を掛けます。これは固定料金にのみ適用されます。FedEx のリアルタイム料金は、常にカート全体の重量に対して見積もられます。

条件

Free shipping from:配送が必要な商品の小計(クーポン適用後、税抜き)がこの金額に達すると、この配送方法は送料無料になります。その場合、FedEx へのリクエストは行われません。空にすると、送料無料は一切適用されません。

Minimum subtotal:同じ小計がこの金額以上の場合にのみ配送方法を表示します。空にすると常に表示されます。

Min weight (kg):配送方法が表示されるためのカートの最低重量。0 は制限なし(デフォルト)を意味します。

Max weight (kg):カートの最大重量。これを超えると配送方法は非表示になります。0 は制限なし(デフォルト)を意味します。

Default product weight (kg):重量が設定されていない商品に使われる重量。FedEx の料金や上記の重量制限に使われます。デフォルト:0.5。空のフィールドも 0.5 kg を意味します。商品の重量は、各商品の重量クラスから換算されます。

Geo zone:この地域内の住所に対してのみ FedEx を提供します。All zones(デフォルト)は制限なしを意味します。ジオゾーンは System > Localisation > Geo Zones で管理します。Ignore shipping zones がオンのときは使用されません。

配送ゾーンを使わない場合の提供範囲

Ignore shipping zones:ジオゾーンを確認せず、下記の国に対して配送方法を提供します。デフォルト:オフ。

Countries:このモードでの配送先国。空にするとすべての国が対象になります。Ignore shipping zones がオンのときにのみ使用されます。

詳細設定

Debug log:API リクエストと料金の計算を storage/logs/vfd_fdx_debug.log.php(OpenCart 4 では system/storage/logs/vfd_fdx_debug.log.php)に書き込みます。このファイルはウェブから読み取れません。API のエラーは、ログがオフでも常に記録されます。キー、トークン、アカウント番号、購入者の住所は決して記録されません。ファイルが 5 MB に達すると、vfd_fdx_debug.old.log.php に移動され、新しいログが始まります。

Log:ログのサイズと最新のエントリを表示します。Clear log をクリックすると空になります。

Remove data on uninstall:オンにすると、拡張機能のアンインストール時に、FedEx の設定、キャッシュされたトークンと料金、ログが削除されます。オフ(デフォルト)の場合は、再インストールに備えてすべてが保持されます。注文された FedEx の料金は、どちらの場合も常に保持されます。

インポート / エクスポート

Export:Download JSON をクリックすると、設定が JSON ファイルとして保存されます。Secret Key はエクスポートされません。

Import:以前にエクスポートした JSON を貼り付け、Import をクリックすると、設定が復元されます(例:別のストアで)。値は通常の保存と同じように検証されます。保存済みの Secret Key は維持されます。

チェックアウト時の動作

OpenCart が配送方法を表示するとき、拡張機能に FedEx の料金を問い合わせます。Geo zone が設定されていて(かつ Ignore shipping zones がオフの場合)、住所がその範囲外であれば、FedEx は提示されません。Requires Shipping が Yes に設定された商品だけが計算に含まれます。それ以外の商品は重量に加算されず、小計にも含まれません。小計は、クーポン割引後・税抜きのこれらの商品の価格です。ギフト券、ポイント、ストアクレジットは考慮されません。次に拡張機能は許可された国(Ignore shipping zones を使用時)、カートの重量、最低小計を確認します。送料無料が適用される場合、料金は 0 となり、FedEx へのリクエストは送信されません。

それ以外の場合、API Key、Secret Key、アカウント番号が設定されていれば、拡張機能は OAuth トークンを取得し、FedEx Rate API に発送元の住所、配送先の住所、カートの重量(kg 単位。重量クラスが lb または oz のストアでは lb 単位)、設定されていれば箱サイズ、そしてデフォルト通貨を優先通貨として送信します。OpenCart で Postcode Required がオンになっている国では、購入者が郵便番号を入力した後にのみリクエストが行われます。国際配送の場合は、カートの税関申告価格も送信されます。州コードは米国とカナダにのみ送信されます。

FedEx は利用可能なサービスを返します。各サービスについて、拡張機能は選択したアカウント料金またはリスト料金を取得し、デフォルト通貨の料金を優先し、FedEx アカウント通貨の料金は設定した為替レートで換算し、換算できない料金は除外します。最も安いサービスが使われます。料金はデフォルト通貨の小数点以下の桁数に丸められ、選択した Tax class の税を加えて、購入者の通貨で表示されます。

トークンは期限切れまでキャッシュされ、FedEx がそれを拒否した場合は自動的に再取得されます。見積もりは 1 時間キャッシュされます。失敗した料金リクエストは 10 分間、失敗したトークンリクエストは 5 分間記憶されるため、障害があってもチェックアウトの更新が毎回遅くなることはありません。API のタイムアウトは 15 秒です。FedEx が応答しない場合、購入者にはエラーは表示されません。固定料金が使われるか、配送方法が非表示になります。その理由はデバッグログに記録されます。

拡張機能は料金を計算するだけです。FedEx の発送データの作成、ラベルの印刷、集荷の手配、荷物の追跡、顧客による FedEx 営業所の選択には対応していません。提示されるのは 1 つのオプション(最も安いサービス)のみで、複数は表示されません。また、箱詰めは行われず、カート全体が 1 つの荷物として見積もられます。

OpenCart 4 では、購入者はチェックアウトページの配送方法ブロックで Choose をクリックし、Shipping method options のウィンドウで FedEx を選択します。この方法は OpenCart 3 と同じように動作します。

注文

FedEx の注文が行われると、購入者に表示された料金が注文とともに保存されます。Sales > Orders の注文ページには FedEx shipping パネルがあります。このパネルには、料金の FedEx service(リアルタイム料金の場合)、Price source(FedEx live rate、Fixed price (no live rate)、Free shipping threshold のいずれか)、そしてデフォルト通貨の Calculated price (excl. tax) が表示されます。値は注文時に固定され、その後に設定を変更しても変わりません。OpenCart 4 では、チェックアウト用の注文が 1 件保持され、購入者が再度確定するたびに更新されます。保存された FedEx の料金もそれと一緒に更新され、購入者が別の配送方法に切り替えると削除されます。

ライセンスキー

この拡張機能は、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox FedEx は、Extensions > Extensions > Shipping > VibeFox FedEx > Edit ページで設定の上にある最初のブロックです。License key にキーを入力し、Activate をクリックします。その後、ブロックにはキーがマスクされた状態、ステータス(ライセンスの有効期限日やドメインなど)が表示され、ステータスを再確認する Check now、別のキーを入力する Change key、このストアからキーを削除する Remove key のボタンが表示されます。その下には Product: opencart-shipping-fedex の行と、vibefox.net のアカウントを開く Manage licenses and domains in your account のリンクがあります。キーを変更できるのは、この拡張機能の Modify 権限を持つ管理者ユーザーのみです。ブロックのテキストは管理画面の言語に従います(英語とロシア語が含まれています)。

キーが受け付けられない場合、ブロックに理由が表示されます(例:Key not found、This key belongs to another product、Domain limit reached、License expired on と日付)。ストアの住所を変更した後、またはアカウントでドメインの枠を解放した後に、Check now をクリックしてください。ライセンスサーバーに接続できない場合、拡張機能は最後に確認したステータスで動作を続けます。

1 つのキーは 1 つのドメインで使用できます。OpenCart の設定にあるストアの住所です。ストアからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、チェックアウトで FedEx の配送方法は購入者に表示されず、料金も計算されません。同じブラウザで管理画面にログインしている管理者ユーザーには、(unlicensed — visible to admins only) の表示付きで、ストアに配送方法がまだ表示されるため、キーを購入する前に拡張機能を設定してテストできます。OpenCart 4 では、このプレビューは利用できません。ストアは管理画面のログインを認識しないため、有効なキーがない場合は、すべての人に対して配送方法が非表示になります。Edit ページを一度開くと、管理画面の Dashboard にリマインダーが表示されます。× をクリックすると 7 日間非表示になります。既存の注文には影響しません。

ライセンスの有効期限が切れても拡張機能は動作を続けますが、アップデートとサポートには更新が必要です。管理画面の Dashboard または Edit ページを開くと、ステータスが自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。拡張機能をアンインストールすると、ライセンスキーとライセンスステータスは常に削除されます。

トラブルシューティング

チェックアウトに FedEx が表示されない:ライセンスが有効であること、Enable/Disable がオンであることを確認してください。Geo zone、または Ignore shipping zones と Countries を確認してください。拡張機能のページ上部の警告、重量の制限、Minimum subtotal を確認してください。リアルタイム料金がない場合、この配送方法には国別料金、* Any other country の行、または Fallback cost が必要です。商品の Requires Shipping が Yes に設定されていることを確認してください。

リアルタイム料金が表示されない:Debug log をオンにして、チェックアウトを再読み込みし、拡張機能のページにある Log の欄を確認してください。誤ったキー、誤った環境(Sandbox オフでテスト用のキーを使う、またはオンで本番用のキーを使う)、配送先の郵便番号の欠落、FedEx のエラーコードがそこに記録されます。

ストアの通貨が USD ではない:FedEx には、ストアのデフォルト通貨での料金を依頼します。アカウントがその独自の通貨のみを返す場合は、FedEx account currency と Exchange rate を設定してください。為替レートがない場合、そのような料金は無視され、固定料金が使われるため、米ドルの金額がユーロとして表示されることはありません。

「Per item」は FedEx の料金を掛けますか?いいえ。Per item は固定料金にのみ適用されます。

変更後も料金が古いままに見える:拡張機能のページを保存すると、キャッシュが消去されます。Clear cached FedEx token and rates をクリックすることもできます。

「Warning: You do not have permission to modify VibeFox FedEx!」と表示される:管理者ユーザーのグループは設定の閲覧のみが許可されている可能性があります。System > Users > User Groups で、そのグループに extension/shipping/vfd_fedex(OpenCart 3)または extension/vfd_fedex/shipping/vfd_fedex(OpenCart 4)の変更権限を付与してください。

開発者向け:他の拡張機能は、OpenCart のイベント vfd_fedex/api_base_url、vfd_fedex/allowed_services、vfd_fedex/rate_request(catalog/vfd_fedex/... として登録)を通じて、API のアドレス、許可された FedEx サービス、料金リクエストを変更できます。設定 vfd_fdx_api_url はテスト用に API のアドレスを置き換えるもので、設定ページにはフィールドがありません。

アンインストール

Extensions > Extensions に移動し、種類 Shipping を選んで、VibeFox FedEx の横にある Uninstall(赤い − ボタン)をクリックします。OpenCart は Enable/Disable、Sort order、Tax class、Geo zone を常にリセットします。キャッシュされたトークンと料金は常に削除されます。Remove data on uninstall がオンの場合は、FedEx の設定とデバッグログも削除されます。オフの場合、その他の設定は保持され、拡張機能を再インストールしたときに再び使われます。注文された FedEx の料金は、どちらの場合も保持され、注文は配送方法と配送料を保持し続けます。

OpenCart 4 で拡張機能のファイルも削除するには、アンインストール後に Extensions > Installer に移動し、インストール済み拡張機能の一覧で VibeFox FedEx の横にある Uninstall(オレンジ色の − ボタン)をクリックしてから、Delete(赤いごみ箱のボタン)をクリックして、アップロードしたパッケージを削除します。

FedEx は、その所有者の商標です。この拡張機能は FedEx とは提携しておらず、FedEx の承認や推奨を受けていません。