VibeFox Australia Post for OpenCart — ヘルプ
動作環境
OpenCart: 3.0.x(3.0.5.0 で検証済み)、または 4.0.2 以降(4.1.0.3 で検証済み)。
PHP: 8.0 以降。
Australia Post PAC API キー(リアルタイム料金のみ): リアルタイム料金には Australia Post の Postage Assessment Calculator(PAC)API を使用します。キーは無料です。Australia Post Developer Centre(developers.auspost.com.au)で PAC API キーに登録してください。設定ページには登録ページへのリンクがあります。発送元の 4 桁のオーストラリア郵便番号も必要です。国ごとの固定料金のみを使用する場合、API キーは不要です。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
ダウンロードは、両方の OpenCart バージョン用のパッケージを含む 1 つの zip ファイルです。お使いのコンピューターで解凍してください。README.txt、OpenCart 3 用パッケージ vfd_australia_post-oc3-(version).ocmod.zip、OpenCart 4 用パッケージ vfd_australia_post.ocmod.zip が含まれています。お使いの OpenCart バージョン用のパッケージのみをインストールしてください。ライセンスキーは両バージョンで共通です。
OpenCart 3
1. 管理画面で Extensions > Installer を開き、Upload をクリックして、ファイル vfd_australia_post-oc3-(version).ocmod.zip を選択します。本拡張機能は OCMOD の変更を追加しないため、Extensions > Modifications を更新する必要はありません。インストーラーを使う代わりに、このパッケージの upload フォルダの内容をストアのルートフォルダにコピーすることもできます。
2. Extensions > Extensions に進み、拡張機能の種類で Shipping を選択します。VibeFox Australia Post を見つけて、Install(緑色の + ボタン)をクリックします。
3. Edit(鉛筆のボタン)をクリックして設定ページを開きます。
4. VibeFox ライセンスキーを、Edit ページ上部のライセンスブロック内の License key に貼り付け、Activate をクリックします(ライセンスキーを参照)。
5. Rate source(料金の取得方法)を選びます。固定料金の場合は Country prices に行を追加します。リアルタイム料金の場合は、PAC API キー、発送元の郵便番号、そしてストアの既定の通貨が AUD でない場合は AUD の換算レートを入力します(設定を参照)。Enable Australia Post をオンにして Save をクリックします。
OpenCart 4
1. 管理画面で Extensions > Installer を開き、Upload をクリックして、ファイル vfd_australia_post.ocmod.zip を選択します。ファイル名は変更しないでください。OpenCart 4 は拡張機能のコードをファイル名から取得するため、名前を変更したパッケージは動作しません。
2. パッケージは、同じページのインストール済み拡張機能の一覧に表示されます。その横の Install(緑色の + ボタン)をクリックします。
3. Extensions > Extensions に進み、拡張機能の種類で Shipping を選択します。VibeFox Australia Post を見つけて、Install(緑色の + ボタン)、次に Edit(鉛筆のボタン)をクリックします。
4. OpenCart 3 の手順 4 と 5 と同じように、ライセンスキーと設定を入力します。設定ページとそのフィールドは、両バージョンで同じです。
インストール直後は、Enable Australia Post をオンにして保存するまで、この配送方法はオフのままです。アンインストール後に拡張機能を再インストールした場合、保持されていた Australia Post の設定が再び使用されます。
設定
すべての設定は拡張機能のページにあります:Extensions > Extensions > Shipping > VibeFox Australia Post > Edit。セクションは左側に一覧表示されます。ページ下部の Save ボタンで、ページ全体を再読み込みせずに保存します。保存のたびに、キャッシュされた Australia Post の料金もクリアされます。この拡張機能の変更権限を持つ管理者ユーザーのみが設定を保存できます。
保存を止めるエラーがあると、何も保存されません。例えば、64 文字を超える Method title、整数ではない Sort order、または存在しない税クラスやジオゾーンなどです。その他の問題はパネルの上に警告として表示され、残りの設定は保存されます。数値でない値や負の値が入った数値フィールドは以前の値を保持し、警告にフィールド名が示されます。数値フィールドは小数点としてピリオドもカンマも受け付けます。
リアルタイム料金のソースを選んだのに、API キー、4 桁の発送元郵便番号、または AUD 換算レートが不足している場合、保存後に警告が表示されます。警告には、修正されるまでの動作も示されます:チェックアウトでこの配送方法が非表示になるか、フォールバックモードでは国ごとの固定料金が使用されます。また、ストアに kg 単位の重量クラスや cm 単位の長さクラスがない場合も、ページで警告されます。その場合、商品の重量と寸法は、それぞれのクラスの単位(kg、g、lb、oz;cm、mm、m、in)に従って変換され、それ以外の単位は kg と cm として扱われます。
General
設定はすべてのジオゾーンに適用されます。Conditions でこの方法をジオゾーンに限定するか、Availability without shipping zones で国のリストに限定できます。
Enable Australia Post: チェックアウトで Australia Post を表示または非表示にします。既定値:オフ。
Method title: カートとチェックアウトで購入者に表示される配送方法の名前。既定値:Australia Post。最大 64 文字です。これより長いタイトルは拒否され、何も保存されません。空欄の場合は警告が表示され、Australia Post が使用されます。
Rate source: 料金の計算方法。
エラーの詳細はログに記録され、購入者には表示されません。
Sort order: チェックアウトの配送方法の中での Australia Post の並び順。整数で指定します。
Australia Post API(リアルタイム料金)(固定料金には不要)
PAC API key: 無料の Australia Post PAC API キー。AUTH-KEY ヘッダーで Australia Post に送信されます。保存後、このフィールドは空になり Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。
Remove the saved API key: オンにして保存すると、保存されたキーが削除されます。その後、リアルタイム料金は使用されなくなります。
Ship-from postcode: 荷物を発送する 4 桁のオーストラリア郵便番号。例:2000。
Domestic service: オーストラリア国内への配送に使用されます(22 kg まで、各辺 105 cm まで):Parcel Post(既定)または Express Post。
International service: オーストラリア国外への配送に使用されます(20 kg まで):International Standard(既定)、International Express、または International Courier。
Remove GST: API の国内料金を 1.1 で割ります。Australia Post の国内料金には 10% の GST が含まれています。OpenCart 自体が配送料に税金を加える場合(Tax class が選択されている場合)にオンにすると、GST が二重に課されないようになります。国際郵便は GST 非課税であり、決して変更されません。
AUD → (your currency) rate: ラベルにはストアの既定の通貨が表示されます。Australia Post の料金は AUD 建てです。既定の通貨が AUD でない場合は、1 AUD が自国の通貨の何単位に相当するかを入力してください。例:0.61。レートは 0 より大きい必要があります。これがないとリアルタイム料金は使用されません。既定の通貨が AUD の場合、このフィールドには換算が不要と表示されます:空欄のままにしてください。
リアルタイム料金用の荷物
カートは 1 つの荷物として送信されます。商品の重量と寸法は、OpenCart の重量クラスと長さクラスから kg と cm に変換されます。以下の値は、重量や寸法のない商品に使用されます。
Default product weight (kg): 重量のない各商品に使用されます。Australia Post へのリクエストと、Min cart weight (kg) / Max cart weight (kg) の確認に使用されます。既定値:1。
Default parcel length (cm): カート内のどの商品にも寸法がない場合に使用されます。既定値:22。
Default parcel width (cm): カート内のどの商品にも寸法がない場合に使用されます。既定値:16。
Default parcel height (cm): カート内のどの商品にも寸法がない場合に使用されます。既定値:8。
商品に寸法がある場合、荷物はそれらの中で最大の長さと幅を採用し、すべての商品の体積を収められるように高さが増やされます。
固定料金(固定料金の場合、およびリアルタイム料金のフォールバックとして使用)
Country prices: ストアの既定の通貨(税抜)による、国と料金のリスト。Add row をクリックして行を追加し、× ボタンで行を削除します。独自の行がないすべての国に適用される料金には * All other countries を選択します。料金のない国(* の行がない場合)には固定料金が適用されないため、その国では配送方法が非表示になります。料金のない行は保存時に削除されます。料金を追加するまで、この表は空です。
Fixed price per: Order(既定)は料金を 1 回だけ請求します。Item (price × quantity) は、カート内の商品数を掛けて請求します。これは固定料金にのみ適用されます。リアルタイム料金は常に荷物全体で計算されます。
Conditions
Min cart weight (kg): カートの重量がこの値未満の場合、配送方法を非表示にします。0 は制限なし(既定)を意味します。
Max cart weight (kg): カートの重量がこの値を超える場合、配送方法を非表示にします。既定値:22。0 は制限なし、空欄の場合は 22 kg を意味します。Australia Post の荷物:国内 22 kg、国際 20 kg。Min cart weight (kg) が最大値より大きい場合、配送方法は表示されなくなります。警告が表示され、両方の重量は以前の値を保持します。
Minimum order amount: 配送が必要な商品の小計(クーポン適用後、税抜、ストアの既定の通貨)がこの金額に達した場合にのみ、配送方法を表示します。常に表示するには空欄のままにします。
Free shipping: 下記の金額以上の場合に送料を無料にします。
Free shipping from: 配送が無料になる、配送が必要な商品の小計(クーポン適用後、税抜)。この場合、API へのリクエストは行われません。Free shipping がオンの場合にのみ使用されます。
Tax class: 配送料の税クラス、または No tax(既定)。Australia Post の国内料金には GST が含まれています。税クラスがある場合は、Remove GST をオンにしてください。
Geo zone: このジオゾーン内の住所にのみ Australia Post を提供します。All zones(既定)は制限なしを意味します。ジオゾーンは System > Localisation > Geo Zones で管理します。Ignore shipping zones を使用する場合は適用されません。
配送ゾーンなしの利用可否
通常、この方法は Conditions で選択されたジオゾーンで提供されます(All zones はどこでも、という意味です)。
Ignore shipping zones: ジオゾーンに関係なく、下記の国に対してこの方法を提供します。
Countries: このモードの配送先の国。入力して検索し、複数選択できます。空欄の場合、ストアで有効なすべての国が許可されます。Ignore shipping zones を使用する場合にのみ使われます。
詳細設定
Debug log: 料金の計算を storage/logs/vfd_ap.log.php に記録します。このファイルはウェブから読み取ることはできません。API のエラーは常に記録されます。API キーと購入者の郵便番号はログに記録されません。作業が終わったらログをオフにしてください。ファイルが 5 MB に達すると、vfd_ap.old.log.php に移動され、新しいログが開始されます。
Log: ログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログが空になります。
Remove data on uninstall: オンの場合、拡張機能をアンインストールすると、設定、キャッシュされた料金、ログが削除されます。オフ(既定)の場合、再インストールのためにこれらは保持されます。
インポート / エクスポート
エクスポート: Download JSON をクリックすると、設定が JSON ファイルとして保存されます。API キーはエクスポートされません。
インポート: 以前にエクスポートした JSON を貼り付けて Import をクリックすると、設定が復元されます。たとえば別のストアに復元する場合などに使用します。値は通常の保存時と同じように検証されます。保存された API キーは保持されます。
チェックアウトでの動作
OpenCart が配送方法を表示するとき、拡張機能に Australia Post の料金を問い合わせます。Geo zone が設定されていて(かつ Ignore shipping zones がオフ)、住所がその外側にある場合、Australia Post は提供されません。Ignore shipping zones を使用する場合は、Countries のリストで判断されます。Requires Shipping が Yes に設定された商品のみが対象です。それ以外の商品は重量に加算されず、注文金額にも含まれません。次に拡張機能はカートの重量と Minimum order amount を確認します。注文金額は、配送が必要な商品の価格で、クーポン割引後、税前の金額です。ギフト券、ポイント、ストアクレジットは考慮されません。送料無料が適用される場合、料金は 0 になり、Australia Post へのリクエストは送信されません。
固定料金モードでは、料金は表から取得されます。リアルタイム料金モードでは、拡張機能は荷物の重量を Australia Post に送信します。オーストラリア国内への配送の場合は、発送元と配送先の郵便番号と荷物のサイズも送信し、国際配送の場合は配送先の国を送信します。国内のリアルタイム料金は、配送先住所に 4 桁の郵便番号がある場合にのみ要求されます。荷物が Australia Post の制限(国内 22 kg または 105 cm、国際 20 kg)を超える場合は、リクエストは送信されません。AUD の料金は換算レートで変換され、Remove GST がオンの場合は国内料金から GST が差し引かれます。料金はストアの既定の通貨で計算され、その通貨の小数桁に丸められ、選択した Tax class の税金を含めて、購入者の通貨で表示されます。
成功した各応答は 1 時間キャッシュされるため、同じカートで新たなリクエストが発生することはありません。失敗したリクエストは 10 分間キャッシュされるため、チェックアウトが更新のたびに Australia Post の応答を待つことはありません。API のタイムアウトは 10 秒です。API のエラーが購入者に表示されることはありません。配送方法は非表示になるか、フォールバックモードでは固定料金が使用されます。理由はログに記録されます。
この拡張機能は料金の計算のみを行います。配送ラベル、eParcel や MyPost Business の出荷・マニフェストの作成、荷物の追跡、購入者によるパーセルロッカーや郵便局の選択は行いません。注文には何も追加されません。注文には、他のすべての OpenCart の配送方法と同様に、配送方法の名前と配送料が表示されます。カートは常に 1 つの荷物として料金が計算されます。手紙、封筒、契約料金(eParcel)は含まれません。
OpenCart 4 では、購入者はチェックアウトページの配送方法ブロックで Choose をクリックし、Shipping method options ウィンドウで Australia Post を選びます。この方法は OpenCart 3 と同じように動作します。
ライセンスキー
この拡張機能は、vibefox.net で購入した VibeFox ライセンスキーで動作します。拡張機能の Extensions > Extensions > Shipping > VibeFox Australia Post > Edit ページでは、設定の上にあるブロックが最初のライセンスブロック License — VibeFox Australia Post です。キーを License key に貼り付けて Activate をクリックします。その後、ブロックにはキーがマスクされて表示され、ステータス(ライセンスの有効期限日やドメインなど)と、ステータスを再確認する Check now、別のキーを入力する Change key、このストアからキーを削除する Remove key のボタンが表示されます。その下には Product: opencart-shipping-australia-post の行と、vibefox.net のアカウントを開くリンク Manage licenses and domains in your account があります。キーを変更できるのは、この拡張機能の変更権限を持つ管理者ユーザーのみです。ブロックの表示テキストは管理画面の言語に従います(英語とロシア語を含みます)。
キーが受け付けられない場合、ブロックには理由が表示されます。例:Key not found、This key belongs to another product、Domain limit reached、または日付付きの License expired on。ストアのアドレスを変更した後、またはアカウントでドメインの枠を解放した後は、Check now をクリックしてください。ライセンスサーバーに接続できない場合、拡張機能は最後に確認できたステータスで動作を続けます。
1 つのキーは 1 つのドメインで使用できます。対象は OpenCart 設定のストアアドレスです。ストアからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。
有効なキーがない場合、チェックアウトで Australia Post は購入者に表示されず、料金も計算されません。同じブラウザで管理画面にログインしている管理者ユーザーには、(unlicensed — visible to admins only) と表示された状態で、ストアに方法が引き続き表示されます。そのため、キーを購入する前に拡張機能を設定してテストできます。OpenCart 4 では、このプレビューは利用できません。ストアは管理画面のログインを認識しないため、有効なキーがない場合は全員に対してこの方法が非表示になります。Edit ページを一度開くと、管理画面の Dashboard にリマインダーが表示されます。× で閉じると、7 日間非表示になります。既存の注文には影響しません。
ライセンスの期限が切れても、拡張機能は動作を続けますが、アップデートとサポートには更新が必要です。管理画面の Dashboard または Edit ページを開くと、ステータスが自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。拡張機能をアンインストールすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
チェックアウトに Australia Post が表示されない: ライセンスが有効であること、Enable Australia Post がオンであることを確認してください。Geo zone(または Ignore shipping zones と Countries)、カートの重量制限、Minimum order amount を確認します。固定料金モードでは、その国または * All other countries に料金が設定されているか確認してください。商品の Requires Shipping が Yes に設定されているかも確認します。
リアルタイム料金が表示されない: Debug log をオンにして、チェックアウトを再読み込みし、拡張機能のページにある Log フィールドを確認してください。理由が表示されます:API キーや発送元の郵便番号がない、4 桁の配送先郵便番号がまだない、荷物が制限を超えている、AUD の換算レートがない、または Australia Post のエラーメッセージ。Live rates, fixed price if the API gives no rate を設定しておけば、問題を修正する間も購入者は固定料金を受け取れます。
ストアが AUD ではない: 換算レート(既定の通貨の何単位が 1 AUD に相当するか)を AUD → (your currency) rate フィールドに入力してください。固定料金は常にストアの既定の通貨で設定されます。
配送料に GST が二重にかかる: Australia Post の国内料金には 10% の GST が含まれています。Tax class が選択されている場合は Remove GST をオンにするか、Tax class を No tax に設定してください。
料金が高すぎる、または低すぎる: 商品の重量と寸法、それらの重量クラスと長さクラス、そして Parcel for live rates の既定値を確認してください。Item (price × quantity) の場合、固定料金は商品数に応じて乗算されます。
変更後に料金が古いようだ: 拡張機能のページで Save をクリックしてください。これによりキャッシュされた Australia Post の料金がクリアされます。
ページに "Warning: You do not have permission to modify VibeFox Australia Post!" と表示される: 管理者ユーザーのグループには、設定の閲覧のみが許可されている可能性があります。System > Users > User Groups で、そのグループに extension/shipping/vfd_australia_post(OpenCart 3)または extension/vfd_australia_post/shipping/vfd_australia_post(OpenCart 4)の変更権限を付与してください。
開発者向け: PAC API のアドレスは、設定 vfd_ap_api_url(テスト用)で置き換えられます。設定ページにはこの項目の入力欄はありません。
アンインストール
Extensions > Extensions に進み、種類 Shipping を選択して、VibeFox Australia Post の横にある Uninstall(赤い − ボタン)をクリックします。この拡張機能のライセンスキーとライセンスステータスは常に削除されます。OpenCart は常に Enable Australia Post、Sort order、Tax class、Geo zone をリセットします。キャッシュされた料金は常に削除されます。Remove data on uninstall がオンの場合、Australia Post の設定とログも削除されます。オフの場合、ほかの設定は保持され、拡張機能を再インストールしたときに再び使用されます。既存の注文は、配送方法と送料をそのまま保持します。
OpenCart 4 で拡張機能のファイルも削除するには、アンインストール後に Extensions > Installer に進み、インストール済み拡張機能の一覧で VibeFox Australia Post の横にある Uninstall(オレンジ色の − ボタン)をクリックし、次にアップロードしたパッケージを削除するために Delete(赤いごみ箱のボタン)をクリックします。
Australia Post は、それぞれの所有者の商標です。本拡張機能は Australia Post と提携しておらず、Australia Post による推奨も受けていません。
