VibeFox Purolator for PrestaShop — ヘルプ
要件
PrestaShop: 8.0～9.x。
PHP: 8.0 以降。古いバージョンの PHP ではモジュールをインストールできません。PHP の SOAP 拡張機能は不要です。
Purolator E-Ship Web Services（リアルタイム料金のみ）: Purolator の Web サイトにある Purolator E-Ship Resource Centre で E-Ship Web Services に登録してください。Purolator は、開発環境と本番環境で別々のキーとパスワードを発行します。また、Purolator の請求アカウント番号と、発送元となるカナダの郵便番号が必要です。固定料金のみを使用する場合は、API キーは不要です。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. 管理画面で Modules > Module Manager に移動し、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックします。後からモジュール一覧で VibeFox Purolator を探し、Configure をクリックすることもできます。
3. Configure ページの上部にあるライセンスブロックで、License key に VibeFox ライセンスキーを入力し、Activate をクリックします（ライセンスキーを参照）。
4. リアルタイム料金を使用する場合は、Purolator API (live rates) セクションに入力します。テストの場合は、開発用キーを使って Development environment をオンにします。固定料金または代替料金を使用する場合は、Country prices または Fallback price に入力します（設定を参照）。Save をクリックします。
インストール時に、モジュールは配送時間のテキストを Purolator courier とした Purolator 配送業者を作成します。配送業者はすべてのゾーンとすべての顧客グループに割り当てられます。ゾーン、顧客グループ、配送時間、ロゴ、サイズ制限は Shipping > Carriers で変更できます。ここでは料金を設定しないでください。料金は常にモジュールから取得されます。
設定
すべての設定はモジュールページにあります: Modules > Module Manager > VibeFox Purolator > Configure。各セクションには個別の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Purolator の料金も消去されます。
保存された値ではリアルタイム料金が機能しない場合（キー、パスワード、請求アカウントがない、カナダの発送元郵便番号がない、CAD のレートがない）、または API の認証情報も固定料金もない場合は、設定の上に警告が表示されます。ストアの重量単位がモジュールの認識する単位（kg、g、lb、oz など）でない場合も警告が表示されます。その場合、商品の重量は kg として扱われます。重量単位は International > Localization（Local units）で設定してください。
0 以上の数値ではない数値フィールドは保存されません。警告にフィールドと値が表示されます。そのフィールドは空のままになるか、重量フィールドの場合はデフォルト値になります。Country prices の誤った値は 0 として保存され、警告に国と列が表示されます。Min cart weight が Max cart weight より大きい場合は、何も保存されず、エラーが表示されます。
一般
Enable Purolator: 配送業者をオンまたはオフにします。これは Shipping > Carriers の配送業者ステータスと同じスイッチです。
Method title: カートと注文手続きに表示される配送業者名。デフォルト: Purolator。必須、最大 64 文字。
Tax: 配送業者の税ルール、または No tax。送料に対してストアが税金を加算するかどうかを決めます。カナダの住所では、Purolator の合計にすでに GST/HST/PST/QST が含まれています。下の Canadian sales taxes を参照してください。
Purolator API（リアルタイム料金）
API キー、パスワード、請求アカウントを入力すると、料金は Purolator E-Ship Estimating ウェブサービスから取得されます。Purolator から料金が返されない場合は固定料金が使用されます。固定料金もない場合は、配送業者が非表示になります。このセクションには Purolator E-Ship Resource Centre へのリンクがあり、そこで登録してキーを取得します。
API key: 選択した環境用の E-Ship Web Services キーです。保存後、このフィールドは空になり、Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。
API password: キーに対応するパスワードです。キーと同様に、保存後は再表示されません。
Billing account number: Purolator のアカウント番号です。見積もりはこのアカウントの料金を使用します。開発環境では、Purolator のドキュメントにあるテストアカウントを使用できます。このフィールドを空にすると、保存された API キーとパスワードも削除されます。
Development environment: 開発用キーを使って Purolator の開発環境（devwebservices.purolator.com）を使用します。料金はテスト用のデータです。実際のストアでは無効にしてください。
Ship-from postal code: 荷物を発送するカナダの郵便番号です（例: L4W 5M8）。
Service in Canada: Cheapest available（デフォルト）、Purolator Ground、Purolator Ground 9AM、Purolator Ground 10:30AM、Purolator Ground Evening、Purolator Express、Purolator Express 9AM、Purolator Express 10:30AM、Purolator Express 12PM、Purolator Express Evening のいずれか。
Service to the USA: Cheapest available（デフォルト）、Purolator Ground U.S.、Purolator Express U.S.、Purolator Express U.S. 9AM、Purolator Express U.S. 10:30AM、Purolator Express U.S. 12:00 のいずれか。
International service: Cheapest available（デフォルト）、Purolator Express International、Purolator Express International 9AM、Purolator Express International 10:30AM、Purolator Express International 12:00 のいずれか。
選択したサービスがその住所で提供されていない場合は、利用可能な中で最も安いサービスが使用されます。
Canadian sales taxes: GST/HST/PST/QST を含まない Purolator の料金を使用します。カナダの住所では、Purolator の合計にこれらの税金が含まれます。配送業者が Tax で税ルールを設定している場合にオンにすると、税金が二重に課されるのを防げます。
CAD → (shop currency) rate: Purolator の料金は CAD 建てです。ストアの既定通貨が CAD でない場合は、CAD 1 単位が貴店の通貨でいくらになるかを入力してください（例: 0.68）。この値がないと、リアルタイム料金は使用されません。既定通貨が CAD の場合は、空のままにしてください。
Default product weight: kg 単位で、重量が設定されていない各商品に使用されます。デフォルト: 0.5。重量はストアの重量単位から換算され、ポンド単位の整数に切り上げた合計重量として Purolator に送信されます。
固定料金（API の認証情報がない場合に使用され、API が料金を返さない場合は代替として使用されます）
Country prices: カート重量と国ごとの料金です。ストアの既定通貨で、税抜きで入力します。Add country をクリックすると行が追加され、ゴミ箱のアイコンをクリックすると行が削除されます。独自の行がないすべての国をカバーする行には、* Default (all other countries) を選択します。各行には Base 料金と、サイズ別の列があります: XS は 1 kg まで、S は 1～2 kg、M は 2～3 kg、L は 3～5 kg、XL は 5 kg 超です。サイズ別料金が空またはゼロの場合は Base が使用されます。Base が 0 の場合、または Base が空の場合は、独自のサイズ別料金がない重量区分について送料無料になります。9.99 と 9,99 のどちらも使用できます。料金が入力されていない行は保存されず、国ごとに保持される行は 1 つだけです。
Fallback price: Country prices に行がなく、* 行もない国の料金です。空のままにすると、そうした国では配送業者が非表示になります。
Fixed price per: Order は料金を 1 回だけ請求します。Item (price × quantity) はカート内の商品数を掛けた料金になります。これは固定料金にのみ適用されます。リアルタイム料金は常に発送全体に対して計算されます。
条件
Min cart weight: kg 単位で、カートの重量がこれより軽い場合は配送業者を非表示にします。0 は制限なしを意味します。
Max cart weight: kg 単位で、カートの重量がこれより重い場合は配送業者を非表示にします。デフォルト: 30。0 は制限なしを意味します。
Minimum order amount: カートの小計（割引後、税抜き）がこの金額に達した場合にのみ配送業者を表示します。空のままにすると、常に表示されます。
Free shipping from: カートの小計（割引後、税抜き）がこの金額以上の場合、配送は無料になります。その場合、Purolator へのリクエストは送信されません。空のままにすると、送料無料は提供されません。
これらの条件で使用されるカート重量では、重量が設定されていない商品は 0 として数えられます。
配送ゾーンを使わない場合の提供範囲
通常、配送業者は Shipping > Carriers で割り当てられたゾーンに提供されます。
Ignore shipping zones: 一致するゾーンに関係なく、下記の国に対して Purolator を提供します。保存すると、配送業者はすべてのゾーンに追加されます。後から作成されたゾーンにも追加されます。このオプションをオフにすると、それらのゾーンは削除されます。
Countries: このモードの配送先の国です。空のままにすると、ストアで有効なすべての国が使用されます。このフィールドは Ignore shipping zones がオンの場合にのみ使用されます。
詳細設定
Debug log: 料金計算の記録を、モジュールフォルダ内の logs/vfd_prlr_debug.log.php に書き込みます。このファイルは Web から開くことはできません。API のエラーは、デバッグログがオフでも常に記録されます。API キー、請求アカウント、購入者の郵便番号はログに記録されません。作業が終わったらログをオフにしてください。
Log: ログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログが空になります。
Remove data on uninstall: オンの場合、モジュールをアンインストールすると、設定、配送業者、キャッシュされた料金、ログが削除されます。オフの場合は、再インストール用にすべてが保持されます。
チェックアウトでの動作
配送の手順で、PrestaShop はモジュールに Purolator の料金を問い合わせます。対象となるのは実物の商品だけです。仮想商品は重量に加算されず、注文金額にも含まれません。購入者が住所を入力する前に、ストアが見積もりに使用する国について料金が推定されます。モジュールはまず条件を確認します: 許可された国（Ignore shipping zones の場合）、カートの重量、最低注文金額です。送料無料が適用される場合、料金は 0 になり、Purolator へのリクエストは送信されません。次に料金を探します: まずリアルタイムの Purolator 料金、次に国ごとの料金表、最後に代替料金です。料金がない場合、配送業者は非表示になります。
API の認証情報がある場合、モジュールは Purolator に Quick Estimate のリクエストを送信します。請求アカウント、発送元の郵便番号、購入者の市区町村、都道府県または州、国と郵便番号、そしてカートの合計重量（ポンド単位の整数）が含まれます。カナダでは有効な郵便番号、米国では有効な ZIP コードが必要です。その他の国は、入力された郵便番号のまま送信されます。寸法（容積重量）は送信されません。Purolator は、購入者の言語に応じてフランス語または英語で応答します。Purolator はすべてのサービスの料金を返します。モジュールは選択したサービス、または最も安いサービスを使用し、設定されていればカナダの売上税を除き、CAD から料金を換算します。料金はストアの既定通貨で計算され、その後、購入者のカート通貨で表示されます。
各応答は 1 時間キャッシュされます。失敗したリクエストは 10 分間キャッシュされるため、Purolator の障害時にもチェックアウトの更新のたびに遅くなることはありません。API のタイムアウトは 10 秒です。
Purolator から料金が返されない場合（API が停止している、認証情報や郵便番号が誤っている、サービスが利用できない、CAD のレートがない）、購入者にエラーは表示されません。固定料金が使用されます。固定料金もない場合は、配送業者が非表示になります。理由はログに記録されます。
注文のある配送業者を Shipping > Carriers で編集した場合、PrestaShop はそれを配送業者の新しいバージョンとして保存します。モジュールは新しいバージョンに自動的に従います。
モジュールは料金の計算だけを行います。Purolator の発送データの作成、送り状の印刷、集荷の予約、返品の処理、荷物の追跡は行いません。Full Estimate（寸法、複数の荷物、署名や危険物などのオプション）は使用せず、配送日は表示せず、複数のサービスを別々の配送業者として表示することもなく、為替レートを自動で取得することもありません。
注文
リアルタイムの Purolator 料金で注文が行われると、そのサービスは注文と一緒に保存されます。その後のカートの再計算では変更されません。管理画面の注文ページ（Orders > Orders、注文を開く）では、Purolator ブロックに Purolator service（名前とコード）と Live rate (excl. tax) が表示されます。固定料金または送料無料で行われた注文には、このブロックはありません。
ライセンスキー
モジュールは、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox Purolator は、Modules > Module Manager > VibeFox Purolator > Configure ページの一番上、設定より上にあります。キーを License key に貼り付けて、Activate をクリックしてください。その後、ブロックにはキーがマスク表示され、ステータス（ライセンスの有効期限日やお使いのドメインなど）と、Check now（ステータスを再確認）、Change key（別のキーを入力）、Remove key（このストアからキーを削除）のボタンが表示されます。その下には Product: presta-shipping-purolator の行と、vibefox.net のアカウントを開くリンク Manage licenses and domains in your account があります。キーを変更できるのは、このモジュールの Configure 権限を持つスタッフだけです。ブロックの表示テキストは管理画面の言語に従います（英語とロシア語が含まれます）。
キーが受け付けられない場合、ブロックには理由が表示されます。例: Key not found、This key belongs to another product、Domain limit reached、または日付付きの License expired on。ストアのアドレスを変更した後、またはアカウントでドメインの枠を解放した後は、Check now をクリックしてください。ライセンスサーバーに接続できない場合、モジュールは最後に確認できたステータスで動作を続けます。
1 つのキーは 1 つのドメインで使用できます。メインストアのドメインを指し、マルチストア構成でも同様です。ストアからキーを削除しても、ドメインの枠は解放されません。枠は vibefox.net のアカウントで解放してください。
有効なキーがない場合、Purolator の配送業者は注文手続きで購入者に表示されず、料金のリクエストも計算も行われません。PrestaShop のストアフロントは、バックオフィスにログインしていることを認識しないため、配送業者はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。
ライセンスの期限が切れた場合も、モジュールは動作を続けますが、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。アンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
Purolator がチェックアウトに表示されない: ライセンスが有効であること、Enable Purolator がオンであることを確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと顧客グループをカバーしているか確認してください（または Ignore shipping zones がオンで、その国が許可されているか確認してください）。重量制限と Minimum order amount も確認してください。Purolator から料金が返されない場合、配送業者は国ごとの料金、* 行、または Fallback price がある場合にのみ表示されます。商品ページで、商品を特定の配送業者に限定することもできます。
リアルタイム料金が表示されない: モジュールページの Log フィールドを確認してください。API のエラーは常にそこに表示されます。詳細については、Debug log をオンにして、チェックアウトを再読み込みしてください。API キーを使用する場合、住所には有効な郵便番号（カナダ）または ZIP コード（米国）が必要です。設定の上にある警告も確認してください。
ログに HTTP 401 が表示される: API キーまたはパスワードが、選択した環境と一致していません。開発用キーは Development environment がオンのときにのみ機能し、本番用キーはオフのときにのみ機能します。
料金が Purolator の Web サイトと異なる: Quick Estimate は、請求アカウントの料金と、容積重量を使わずポンド単位に切り上げた合計重量を使用します。カナダの住所では、合計に売上税が含まれます。配送業者に税ルールがある場合は、Canadian sales taxes を使用してください。料金は CAD → (shop currency) rate で換算されます。
保存後に値が消えた: Save の後に表示された警告を確認してください。その値は 0 以上の数値ではなかったため、保存されませんでした。通常の数字として入力し直してください。
変更後に料金が古いようだ: モジュールページで Save をクリックしてください。これにより、キャッシュされた Purolator の料金が消去されます。
Purolator の配送業者が見つからないと表示される: 配送業者は Shipping > Carriers で削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。
アンインストール
Modules > Module Manager に移動し、VibeFox Purolator の横にあるメニューを開いて Uninstall を選択します。ライセンスキーとライセンスステータスは常に削除されます。キャッシュされた料金は常に削除されます。Remove data on uninstall がオンの場合、配送業者は削除されます（注文は履歴を保持します）。設定、注文に保存された Purolator サービス、ログも削除されます。オフの場合、配送業者は無効化されるだけで、すべての設定は保持されます。確定済みの注文は Purolator サービスを保持します。モジュールを再インストールするか、Reset を行うと、配送業者は以前のステータスに戻ります。
Purolator は、その所有者の商標です。本モジュールは Purolator と提携しておらず、Purolator の承認も受けていません。