戻る

VibeFox Australia Post for PrestaShop — ヘルプ

動作環境

PrestaShop:8.0 から 9.x。

PHP:8.0 以降。古いバージョンの PHP では、モジュールはインストールされません。

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 つのドメインで使用できます。

インストール

1. 管理画面で Modules > Module Manager に移動し、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。

2. アップロードが完了したら Configure をクリックします。後で行う場合は、モジュール一覧から VibeFox Australia Post を探し、Configure をクリックします。

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

4. Rate source を選択します。リアルタイム料金を使う場合は、PAC API キー、発送元の郵便番号を入力します。ストアのデフォルト通貨が AUD でない場合は、AUD への換算レートも入力します(「設定」を参照)。Save をクリックします。

インストール時に、モジュールは配送時間のテキスト Australia Post parcel delivery を含む Australia Post 配送業者を作成します。この配送業者は、すべてのゾーンと、すべての顧客グループに割り当てられます。ゾーン、顧客グループ、配送時間、ロゴ、サイズ制限、税ルールは Shipping > Carriers で変更できます。ここでは料金を設定しないでください。料金は常にモジュールから取得されます。

設定

すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox Australia Post > Configure。設定はすべてのゾーンに適用されます。ページの上部には、Shipping > Carriers における配送業者の名前と ID が表示されます。各セクションには専用の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Australia Post の料金もクリアされます。

リアルタイム料金のソースを選択しているのに、API キー、4 桁の発送元郵便番号、または AUD 換算レートが入力されていない場合、保存後に警告が表示されます。警告には、修正するまでの動作も示されます。配送業者はチェックアウト時に非表示になるか、フォールバックモードでは国ごとの固定料金が使用されます。

数値フィールドでは、小数点としてピリオドまたはカンマを入力できます。数値でない値、または負の値は保存されません。警告でフィールド名が示され、以前の値が保持されます。ストアの重量または寸法の単位(International > Localization)がモジュールで対応していない単位の場合も、ページに警告が表示されます。その場合、商品の重量は kg、寸法は cm として扱われます。

一般

Enable Australia Post:すべてのゾーンで配送業者を一度に無効にします。これは Shipping > Carriers にある配送業者のステータスと同じスイッチです。

Method title:購入者がチェックアウトで見る配送業者の名前です。Shipping > Carriers での配送業者の名前でもあり、そちらで名前を変更するとこのフィールドも更新されます。既定値:Australia Post。最大 64 文字:これより長いタイトルは拒否され、何も保存されません。フィールドが空の場合、または PrestaShop が配送業者名で許可していない文字が含まれている場合は警告が表示され、Australia Post が使用されます。

Tax status:送料に税金をどのように適用するかを指定します。

Taxable:Shipping > Carriers で配送業者に選択された税ルールグループが送料に加算されます。税ルールはそちらで選択してください。新しい配送業者には税ルールがありません。税ルールが設定されるまで、モジュールのページには税金が加算されないという警告が表示されます。
None:税金なし。保存すると、配送業者の税ルールグループがリセットされます。モジュールはこの設定を記憶しています。再び Taxable を選択すると、以前の税ルールが戻ります。

Rate source:料金の計算方法です。

Fixed prices (Country prices table):料金は Country prices テーブルから取得されます。API キーは不要です。
Live rates from Australia Post API:カートごとに Australia Post へ料金を問い合わせます。API が料金を返さない場合(API が停止している、郵便番号が無効、荷物が上限を超えている)、そのカートでは配送業者が非表示になります。
Live rates, fixed price if the API gives no rate:Australia Post へ料金を問い合わせます。API が料金を返さない場合は、その国の固定料金が使用されます。

エラーの詳細はログに記録され、購入者に表示されることはありません。

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:オンにして保存すると、保存されている API キーが削除されます。その後、リアルタイム料金は取得されなくなります。

Ship-from postcode:荷物を発送する 4 桁のオーストラリアの郵便番号(例:2000)です。

Domestic service:オーストラリア国内への配送に使用されます(最大 22 kg、1 辺の最大 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 が含まれています。PrestaShop が送料に税金を自動で加算する場合(Tax status = Taxable、かつ配送業者に税ルールがある場合)に、GST が二重に課税されないようオンにしてください。国際郵便に GST は含まれておらず、この値が変更されることはありません。

AUD → (your currency) rate:ラベルにはストアのデフォルト通貨が表示されます。Australia Post の料金は AUD です。デフォルト通貨が AUD でない場合は、AUD 1 単位が自国通貨で何単位に相当するかを入力してください(例:0.61)。レートは 0 より大きい必要があります。レートがない場合、リアルタイム料金は使用されません。デフォルト通貨が AUD の場合、ページに換算は不要と表示されます。その場合はフィールドを空のままにしてください。小数点区切りとして、ピリオドとカンマのどちらも受け付けます。

リアルタイム料金の荷物

カートは 1 つの荷物として送信されます。商品の重量とサイズは、ストアの単位から 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:2 文字の国コード(AU、NZ、US など)と、ストアのデフォルト通貨による税抜きの料金の表です。Add row をクリックすると国を追加でき、× のリンクをクリックすると削除できます。それ以外のすべての国には * を使用します。料金のない国(* の行もない場合)には固定料金がないため、その国では配送業者が非表示になります。無効な国コードや料金のない行は、保存時に削除されます。料金を追加するまで、表は空です。

Fixed price per:Order は料金を 1 回だけ請求します。Item (price × quantity) は、カート内の商品数を掛けた金額を請求します。これは固定料金のみに適用されます。リアルタイム料金は常に荷物全体に対して計算されます。

条件

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 がオンの場合にのみ使用されます。

配送ゾーンなしの場合の提供

通常、配送業者は Shipping > Carriers で選択されたゾーンで提供されます。

Ignore shipping zones:一致するゾーンに関係なく、下記の国に対して配送業者を提供します。保存すると、配送業者はすべてのゾーンに関連付けられ、後で作成されたゾーンも自動的に関連付けられます。オプションをオフにすると、配送業者が以前持っていたゾーンが戻ります。

Countries:このモードの配送先の国です。空のままにすると、有効なすべての国が許可されます。Ctrl(Mac では Cmd)を押しながらクリックすると、複数の国を選択できます。Ignore shipping zones を使用している場合にのみ使用されます。

詳細設定

Debug log:料金の計算を modules/vfd_australia_post/logs/vfd_ap.log.php に記録します。このファイルは Web から開くことはできません。API のエラーは常に記録されます。API キーと購入者の郵便番号は記録されません。作業が終わったらログをオフにしてください。

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

Remove data on uninstall:オンの場合、モジュールをアンインストールすると、設定、キャッシュされた料金、ログが削除されます。配送業者は、アンインストール時に常に削除されます。データが保持されている場合、再インストールすると配送業者が復元されます。

チェックアウトでの動作

配送ステップで PrestaShop はモジュールに Australia Post の料金を要求します。対象となるのは実物の商品のみです。仮想商品は重量に加算されず、注文金額にも含まれません。モジュールは最初に条件を確認します。確認するのは、Countries のリスト(Ignore shipping zones と併用)、カートの重量、Minimum order amount です。送料無料が適用される場合、料金は 0 になり、Australia Post へのリクエストは送信されません。

固定料金モードでは、料金はテーブルから取得されます。リアルタイム料金モードでは、モジュールは荷物の重量を Australia Post に送信します。オーストラリア国内への配送の場合は、発送元と配送先の郵便番号、および荷物のサイズも送信します。国際配送の場合は、配送先の国を送信します。国内のリアルタイム料金は、配送先の住所に 4 桁の郵便番号がある場合にのみ問い合わせます。荷物が Australia Post の上限(国内 22 kg または 105 cm、国際 20 kg)を超える場合、リクエストは送信されません。AUD の料金はお使いの換算レートで換算され、Remove GST がオンの場合、国内料金から GST が除かれます。料金はストアのデフォルト通貨で計算され、その後、購入者のカートの通貨で表示されます。

成功した応答はそれぞれ 1 時間キャッシュされるため、同じカートで新たなリクエストが発生することはありません。失敗したリクエストは 10 分間キャッシュされるため、チェックアウトの更新のたびに Australia Post の応答を待つことはありません。API のタイムアウトは 10 秒です。API のエラーが購入者に表示されることはありません。配送業者が非表示になるか、フォールバックモードでは固定料金が使用されます。理由はログに記録されます。

配送業者に注文が入った後に Shipping > Carriers で編集すると、PrestaShop は新しいバージョンの配送業者として保存します。モジュールは新しいバージョンに自動的に従います。

モジュールは料金の計算のみを行います。配送ラベル、eParcel や MyPost Business の発送データ、マニフェストは作成せず、荷物の追跡も行いません。また、購入者がパーセルロッカーや郵便局を選択できるようにすることもありません。カートは常に 1 つの荷物として計算されます。レター、サッチェル、契約料金(eParcel)は含まれません。

ライセンスキー

このモジュールは、vibefox.net で取得した VibeFox ライセンスキーを使用します。License — VibeFox Australia Post のライセンスブロックは、Modules > Module Manager > VibeFox Australia Post > Configure の一番上、設定より上にあるブロックです。キーを License key に入力し、Activate をクリックします。その後、ブロックにはマスクされたキー、ステータス(ライセンスの有効期限日やドメインなど)、そして Check now(ステータスを再確認)、Change key(別のキーを入力)、Remove key(このショップからキーを削除)のボタンが表示されます。その下には Product: presta-shipping-australia-post の行と、Manage licenses and domains in your account のリンク(vibefox.net のアカウントが開きます)があります。キーを変更できるのは、モジュールの Configure 権限を持つスタッフだけです。ブロックの文言はバックオフィスの言語に従います(英語とロシア語が含まれます)。

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

1 つのキーは 1 つのドメインで使用できます。マルチストア構成の場合も、メインショップのドメインが対象です。ショップからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

有効なキーがない場合、Australia Post の配送業者はチェックアウト時に購入者に表示されず、料金も計算されません。PrestaShop のストアフロントはバックオフィスにログインしていることを認識しないため、配送業者はあなたにも非表示になります。キーを購入する前にモジュールを設定することはできますが、チェックアウトでのテストはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。

ライセンスが期限切れになっても、モジュールは動作を続けます。ただし、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キー入力後最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。

トラブルシューティング

チェックアウトに Australia Post が表示されない:ライセンスが有効であること、Enable Australia Post がオンであること(配送業者が Shipping > Carriers で有効になっていること)を確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと購入者のグループを対象にしていることを確認します(または、Ignore shipping zones がオンになっており、Countries でその国が許可されていること)。カートの重量制限と Minimum order amount も確認してください。固定料金モードでは、その国または * に料金が設定されていることを確認します。また、商品ページで特定の配送業者に限定されている場合もあります。

リアルタイム料金が表示されない:Debug log をオンにし、チェックアウトを再読み込みして、モジュールのページにある Log の欄を確認してください。原因が表示されます。API キーまたは発送元の郵便番号がない、配送先の 4 桁の郵便番号がまだない、荷物が上限を超えている、AUD の換算レートがない、あるいは Australia Post のエラーメッセージが出ている、などです。Live rates, fixed price if the API gives no rate を使用していれば、問題を修正している間も購入者には固定料金が表示されます。

ストアが AUD を使っていない:AUD → (your currency) rate の欄に換算レート(AUD 1 単位がデフォルト通貨で何単位に相当するか)を入力してください。固定料金は常にデフォルト通貨で設定されます。

送料に GST が二重に課税される:Australia Post の国内料金には 10% の GST が含まれています。Tax status が Taxable で、配送業者に税ルールがある場合は、Remove GST をオンにするか、Tax status を None に設定してください。

送料に税金が加算されない:Tax status = Taxable の場合、税金は配送業者の税ルールから適用されます。Shipping > Carriers でそのルールを選択してください。配送業者に税ルールがない間は、モジュールのページに警告が表示されます。

料金が高すぎる、または低すぎる:商品の重量と寸法、および Parcel for live rates の既定値を確認してください。Item (price × quantity) を使用している場合、固定料金は商品数に応じて掛け算されます。

変更後に料金が古いままになる:モジュールのページで Save をクリックしてください。これにより、キャッシュされた Australia Post の料金がクリアされます。

Australia Post の配送業者が削除されたと表示される:配送業者は Shipping > Carriers で削除されています。モジュールのページで Save をクリックすると再作成されます。または、Modules > Module Manager でモジュールをリセットしてください。

アンインストール

Modules > Module Manager に移動し、VibeFox Australia Post の横にあるメニューを開いて、Uninstall を選択します。ライセンスキーとライセンスステータスは常に削除されます。配送業者は常に削除されます(注文の履歴は保持されます)。キャッシュされた料金もクリアされます。Remove data on uninstall がオンの場合、設定、料金キャッシュのテーブル、ログも削除されます。オフの場合は設定が保持され、モジュールを再インストールすると、ゾーン、グループ、ロゴを含む配送業者が復元されます。

Australia Post は、その所有者の商標です。本モジュールは Australia Post と提携しておらず、Australia Post による承認も受けていません。