VibeFox bpost Cubee for PrestaShop — ヘルプ
要件
PrestaShop:8.0 から 9.x。
PHP:8.0 以降。モジュールは古い PHP バージョンではインストールできません。
bpost Shipping Platform アカウント(受け取りポイントセレクターのみで必要):モジュールは bpost Shipping Platform API を通じて受け取りポイントを検索します。plugins.bpost.be で bpost Shipping Platform アカウントにログインし、Settings > Key management でキーを作成してください。必要な値は 3 つです:Account ID(公開キー)、Passphrase(秘密キー)、App ID(X-APPID)。App ID は bpost が連携用に発行するもので、bpost の e-commerce サポート(eol@bpost.be)に問い合わせてください。また、契約の配送業者 ID(68 = bpost)も必要です。キーが完全でない場合も配送業者は固定料金で動作しますが、購入者に受け取りポイントの選択は求められません。
VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. 管理画面で Modules > Module Manager を開き、Upload a module をクリックします。モジュールの ZIP ファイルを選択してください。
2. アップロードが完了したら Configure をクリックします。後からモジュール一覧で VibeFox bpost Cubee を探し、Configure をクリックすることもできます。
3. Configure ページ上部のライセンスブロックで、VibeFox ライセンスキーを License key に入力し、Activate をクリックします(「ライセンスキー」を参照)。
4. 料金と、受け取りポイントセレクター用の bpost API キーを入力してください(設定を参照)。Save をクリックします。
インストール時、モジュールは配送時間のテキストを Pickup point or parcel locker として、配送業者 bpost parcel locker を作成します。配送業者はベルギーのゾーンとすべての顧客グループに紐付けられ、税ルールは設定されません。ゾーン、顧客グループ、配送時間のテキスト、ロゴは Shipping > Carriers で変更できます。料金はここでは設定しないでください。料金は常にモジュールから取得されます。
設定
すべての設定はモジュールページにあります:Modules > Module Manager > VibeFox bpost Cubee > Configure。各セクションには独自の Save ボタンがあり、ページ全体を保存します。保存のたびに、保存済みの API トークンと、キャッシュされた受け取りポイントのリストも消去されます。
配送業者またはセレクターを静かに非表示にする状況があると、ページに警告が表示されます。受け取りポイントセレクターは有効なのに API キーが不完全な場合、ベルギー(BE)の料金もデフォルト料金もない場合、bpost API への最後の接続に失敗した場合、ショップの重量単位がモジュールで認識されない場合(International > Localization の Local units で設定してください)、または bpost の配送業者が見つからない場合です。保存時には、読み取れなかった Country prices の行が警告に一覧表示され、サイズを認識できなかった Size prices の値も同様に表示されます。数値でない、または負の重量や金額は保存されません。警告でフィールドが示され、以前の値が維持されます。Min weight (kg) が Max weight (kg) より大きい場合は、重量も保存されません。
一般
Enable/Disable:bpost parcel locker の配送を有効または無効にします。これは Shipping > Carriers の配送業者のステータスと同じスイッチです。
Name:チェックアウトで購入者に表示される配送方法の名前(配送業者の名前)。デフォルト:bpost parcel locker。空欄の場合はデフォルトが使われます。最大 64 文字。これより長い名前は拒否され、何も保存されません。
Tax status:None は料金が最終価格であることを意味します。税ルールを設定した Taxable では、そのルールの税が料金に上乗せされます。この選択は配送業者に保存されます。
bpost API(受け取りポイント検索)(受け取りポイントセレクターにのみ必要)
Account ID (public key):plugins.bpost.be の Key management にある、bpost Shipping Platform アカウントの公開キーです。このフィールドを空にすると、保存されている Passphrase も削除されます。
Passphrase (private key):すべてのリクエストに署名するために使われる秘密キーです(HMAC-SHA256)。bpost に送信されることも、ログに書き込まれることもありません。保存後、フィールドは空のままになり、Saved - leave empty to keep it. と表示されます。変更したい場合にのみ新しい値を入力してください。
App ID (X-APPID):bpost が連携用に発行したアプリケーション識別子です。X-APPID ヘッダーで送信されます。
Carrier ID:受け取りポイントや宅配ロッカーを一覧表示する、bpost Shipping Platform 契約の配送業者です。デフォルト:68(bpost)。契約で有効になっている他の配送業者には、それぞれ別の ID があります。
受け取りポイントセレクター
Pickup points:チェックアウトに受け取りポイントと宅配ロッカーのセレクターを表示します。デフォルトで有効です。セレクターが表示され、受け取りポイントが必須になるのは、3 つの API キーすべてが入力されている場合だけです。
Search field width:郵便番号 / 市区町村フィールドの CSS 幅(例:100% または 300px)。デフォルト:100%。
Pickup point list width:受け取りポイントリストの CSS 幅(例:100% または 400px)。デフォルト:100%。
料金(ショップのデフォルト通貨、税抜き。bpost はこの API を通じて配送料金を返しません)
Price by:料金の決め方です。
Country prices:国ごとに 1 行、CC=料金 の形式で入力します(例:BE=4.95)。*=料金 の行は、他のすべての国の料金を設定します(例:*=9.95)。小数点とカンマのどちらも小数点記号として受け付けられます。無効な行は無視されます。料金のない国(* の行がない場合)には、配送業者は表示されません。
Size prices:Price by がパッケージサイズの場合に使われ、S=3.50, M=4.50, L=6.00, XL=8.00 の形式で入力します。サイズはカートの重量から決まります:S は 2 kg まで、M は 5 kg まで、L は 10 kg まで、XL は 10 kg 超。
Calculation:Per order は料金を 1 回だけ請求します。Per item (price x number of items) はカート内の商品数を掛けます。
料金はデフォルト通貨の小数桁に丸められ、その後、購入者のカート通貨で表示されます。
条件
Min weight (kg):配送業者が表示されるための最小カート重量。商品の重量はショップの重量単位から換算されます。0 は制限なしを意味します。
Max weight (kg):このカート重量を超えると配送業者は非表示になります。デフォルト:30。bpost の宅配ロッカーは 30 kg までの荷物を受け付けるためです。0 は制限なしを意味します。
Minimum order amount:カートの小計がこの金額に達した場合にのみ配送業者を表示します。小計は、配送が必要な商品を対象とし、割引後、税抜きで計算されます。空欄にすると、配送業者は常に表示されます。
送料無料
Free shipping:下記の金額以上で送料を無料にする場合に有効にします。
Free shipping from:送料が無料になるカート小計(配送が必要な商品、割引後、税抜き)。Free shipping が有効な場合にのみ使われます。国には料金が必要で、料金がないと配送業者は表示されません。
配送ゾーンを使わない場合の提供
通常、配送業者は Shipping > Carriers で設定した配送ゾーンで提供されます。インストール時は、ベルギーのゾーンです。
Ignore shipping zones:下記の国で、ゾーンに追加せずに配送業者を提供します。この場合、配送業者はその後作成するゾーンを含め、すべての有効なゾーンに紐付けられます。このオプションを再度オフにすると、配送業者は以前のゾーンを取り戻します。
Countries:このモードで対象とする配送先の国。デフォルト:ベルギー。空欄にすると、配送を行うすべての国が対象になります。このフィールドは Ignore shipping zones が有効な場合にのみ使われます。
詳細設定
Debug log:API リクエストと料金計算を、モジュールフォルダー内の logs/vfd_bpst_debug.log.php に記録します。このファイルは Web から開くことはできません。API エラーは、このオプションがオフでも常に記録されます。キーとトークンは記録されません。
Log:デバッグログのサイズと最新のエントリーを表示します。Clear log をクリックすると消去されます。
Remove data on uninstall:有効にすると、モジュールをアンインストールしたときに、モジュールの設定と配送業者が削除されます。注文に保存された受け取りポイントは、常に保持されます。
チェックアウトでの動作
配送ステップで、PrestaShop は bpost の料金をモジュールに問い合わせます。配送が必要な商品のみが計算対象です。バーチャル商品は重量に加算されず、注文金額にも含まれません。モジュールは条件を確認します。Ignore shipping zones の国(有効な場合)、カートの重量、最低注文金額です。次に、国のリストまたはパッケージサイズから料金を取得し、商品ごとのモードでは商品数を掛け、送料無料が適用される場合はゼロにします。料金のために bpost へのリクエストは送信されません。
bpost の配送業者の下に、購入者には Postal code or city のフィールド、Search ボタン、受け取りポイントのリストが表示されます。購入者が配送業者を選び、まだ検索していない場合は、配送先住所の郵便番号が自動的に検索されます。購入者は別の郵便番号や市区町村名を入力できます。各ポイントは名前と住所とともに表示されます。最大 50 件のポイントが一覧表示されます。ショップの言語がオランダ語の場合はオランダ語で、それ以外の場合はフランス語でリストが取得されます。
購入者は受け取りポイントを選ぶ必要があります。選ばないと、配送ステップの Continue は Please select a bpost pickup point. を表示し、Place order ボタンは同じメッセージとともにページ上で保留されます。検索用の bpost リストにあるポイントのみが受け付けられます。それ以外の場合、購入者には The selected bpost pickup point is not in the list of your search. Please choose another one. と表示されます。検索と選択はカートとともに保存されるため、ページを再読み込みしても失われません。新しい検索を行うと、以前の選択は消去されます。
受け取りポイントを一覧表示するため、モジュールは検索した郵便番号または市区町村、国、配送業者 ID のみを、あなたのキーで署名して bpost に送信します。API トークンは自動的に取得・更新されます。bpost がトークンを拒否した場合は、新しいトークンを 1 回取得して検索をやり直します。検索結果は 6 時間キャッシュされます。bpost が応答しない場合、購入者には Pickup points cannot be loaded right now. Please try again in a few minutes or choose another shipping method. と表示され、モジュールは 5 分後に再試行します。API のタイムアウトは 15 秒です。
配送業者に注文が入った後で Shipping > Carriers でその配送業者を編集すると、PrestaShop はそれを配送業者の新しいバージョンとして保存します。モジュールは新しいバージョンに自動的に従います。
モジュールは固定料金のみを使用します。bpost からリアルタイムの料金を取得したり、配送を作成したり、ラベルを印刷したり、荷物を追跡したりはしません。受け取りポイントは地図ではなくリストで表示されます。配送は bpost Shipping Platform または Shipping Manager のアカウントで作成してください。受け取りポイント ID は注文に含まれています。
受け取りポイント
注文時に、選択された受け取りポイント(名前と住所)とその ID が注文とともに保存されます。管理画面の注文ページには、bpost pickup point ブロックにポイントと ID が表示されるか、No pickup point was selected for this order. と表示されます。Change をクリックし、郵便番号または市区町村を検索して、リストから別のポイントを選び、Save をクリックしてください。注文はすぐに更新され、ページには Pickup point updated. と表示されます。Debug log が有効な場合、変更はモジュールのデバッグログに書き込まれます。Change リンクは API キーが入力されている場合にのみ利用できます。新しいポイントを保存するには注文を編集する権限が必要です。権限がない場合、ページには Permission denied. と表示されます。Modules ページへのアクセスは必要ありません。
PrestaShop がカートを複数の注文に分割した場合、受け取りポイントは最初の注文に残ります。ほかの注文には受け取りポイントがなく、デバッグログには最初の注文の名前を含むエラーが表示されます。その場合、bpost でこれらの荷物のポイントを手動で設定してください。
購入者は、注文確認ページと、アカウントの注文詳細で、受け取りポイントを bpost pickup point: として確認できます。注文確認メールの配送業者名にも追加されます。ショップに届く新規注文メール(メールアラートモジュールを使用している場合)にも、ポイントの ID が含まれます。
宅配ロッカーと自宅への配送を一緒に提供するには、同じゾーンで自宅への配送に別の配送業者を使用してください。受け取りポイントセレクターは、bpost の配送業者の下にのみ表示されます。
ライセンスキー
本モジュールは、vibefox.net の VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox bpost Cubee は、設定の上にある Modules > Module Manager > VibeFox bpost Cubee > Configure の最初のブロックです。キーを License key に入力し、Activate をクリックします。その後、ブロックにはマスクされたキー、ステータス(ライセンスの有効期限日やお使いのドメインなど)、Check now(ステータスを再確認)、Change key(別のキーを入力)、Remove key(このショップからキーを削除)のボタンが表示されます。その下には Product: presta-shipping-bpost-cubee の行と、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 アカウントで枠を解放してください。
有効なキーがない場合、bpost の配送業者はチェックアウトで購入者に表示されず、送料も計算されません。PrestaShop のフロントエンドは、管理画面にログインしていることを認識しないため、配送業者は管理者にも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでのテストはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。
ライセンスの有効期限が切れてもモジュールは動作し続けますが、アップデートとサポートには更新が必要です。管理画面で作業している間、ステータスは自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは必ず削除されます。
トラブルシューティング
チェックアウトに bpost が表示されない:ライセンスが有効であること、Enable/Disable がオンであることを確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと顧客グループを対象としていること、または Ignore shipping zones がオンで、その国が Countries に含まれていることを確認してください。その国に料金があること、または *=料金 の行があることを確認し、重量制限と Minimum order amount も確認してください。商品ページで、商品が特定の配送業者に制限されている場合もあります。ベルギーに料金がない場合、設定ページに警告が表示されます。
チェックアウトに受け取りポイントセレクターが表示されない:Pickup points がオンであること、Account ID (public key)、Passphrase (private key)、App ID (X-APPID) がすべて入力されていることを確認してください。キーが不完全な場合、設定ページに警告が表示されます。
購入者に "Pickup points cannot be loaded right now" と表示される:bpost が応答しなかったか、キーを拒否しました。理由は設定ページとデバッグログ(モジュールページの Log フィールド)に表示されます。モジュールは 5 分後に自動で再試行します。設定を保存すると、すぐに再試行されます。
この郵便番号または市区町村の受け取りポイントが見つからない:この検索に対して bpost がポイントを返しませんでした。購入者に近くの郵便番号や市区町村名を試してもらい、Carrier ID を確認してください。
カンマを含む料金は使用されない:5,50 と 5.50 はどちらも受け付けられます。CC=料金 の形式に従わない Country prices の行は無視されます。保存後の警告に、その行が一覧表示されます。
料金は税込みですか?Tax status が None の場合、料金は最終価格です。Taxable の税ルールを使うと、PrestaShop はその税を料金に追加します。
ページに bpost の配送業者が見つからないと表示される:配送業者が Shipping > Carriers で削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。
開発者向け:フック actionVfdBpstApiUrl と actionVfdBpstApiLanguage は、bpost API のアドレスと受け取りポイントリストの言語を変更します。
アンインストール
Modules > Module Manager に移動し、VibeFox bpost Cubee の横のメニューを開いて Uninstall を選びます。ライセンスキーとライセンスステータスは、常に削除されます。保存されている API トークンとキャッシュされた受け取りポイントのリストは、常に削除されます。Remove data on uninstall が有効な場合、配送業者は削除されます(注文の履歴は保持されます)。また、未完了のカートの設定、ログ、受け取りポイントも削除されます。無効な場合、配送業者は無効になるだけで、すべての設定は保持されます。モジュールを再インストールすると、配送業者はアンインストール前のステータスに戻ります。Modules > Module Manager の Reset も同じように動作するため、無効にした配送業者は無効のままです。注文に保存された受け取りポイントは注文履歴であり、削除されることはありません。
bpost は各所有者の商標です。このモジュールは bpost と提携しておらず、bpost による推奨も受けていません。
