VibeFox DPD Pickup for OpenCart — ヘルプ
要件
OpenCart: 3.0.x(3.0.5.0 で動作確認)または 4.0.2 以降(4.1.0.3 で動作確認)。
PHP: 8.0 以降。
DPD Baltic の認証情報(リトアニア、ラトビア、エストニア): 受け取りポイントの一覧は DPD Baltic の Web サービスから取得されます。DPD が法人のお客様に発行する API のユーザー名とパスワードが必要です。DPD の担当アカウントマネージャー、またはお住まいの国の DPD カスタマーサービスにお問い合わせください。1 つのアカウントで、リトアニア、ラトビア、エストニアの受け取りポイントを一覧表示できます。
DPD Slovakia: DPD Slovakia の公開 parcelshop 検索には認証情報は不要です。
重量クラス: 商品の重量は kg に換算されます。ストアには、System > Localisation > Weight Classes に単位 kg の重量クラスが必要です(OpenCart には既定で 1 つ含まれています)。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
ダウンロードは、両方の OpenCart バージョン用のパッケージを含む 1 つの zip ファイルです。コンピューターで展開してください。README.txt、OpenCart 3 用パッケージの vfd_dpd_pickup-oc3-(version).ocmod.zip、OpenCart 4 用パッケージの vfd_dpd_pickup.ocmod.zip が含まれています。お使いの OpenCart バージョンのパッケージだけをインストールしてください。ライセンスキーは両方のバージョンで同じです。
OpenCart 3
1. 管理画面で Extensions > Installer に移動し、Upload をクリックして、ファイル vfd_dpd_pickup-oc3-(version).ocmod.zip を選択します。本拡張機能は OCMOD の変更を追加しないため、Extensions > Modifications を更新する必要はありません。Installer を使わずに、このパッケージの upload フォルダーの内容をストアのルートフォルダーにコピーすることもできます。
2. Extensions > Extensions に移動し、拡張機能の種類で Shipping を選びます。VibeFox DPD Pickup を見つけて、Install(緑色の + ボタン)をクリックします。
3. Edit(鉛筆ボタン)をクリックして設定ページを開きます。
4. Edit ページ上部のライセンスブロックにある License key 欄に VibeFox ライセンスキーを貼り付け、Activate をクリックします(ライセンスキーを参照)。
5. DPD API を選択します。DPD リトアニア、ラトビア、エストニアの場合は、API のユーザー名とパスワードを入力します。国ごとの料金を確認し、Enable/Disable を有効にして Save をクリックします。その後 Refresh pickup points をクリックして接続を確認します(設定を参照)。
OpenCart 4
1. 管理画面で Extensions > Installer に移動し、Upload をクリックして、ファイル vfd_dpd_pickup.ocmod.zip を選択します。ファイル名を変更しないでください。OpenCart 4 は拡張機能のコードをファイル名から取得するため、名前を変更したパッケージは動作しません。
2. 同じページのインストール済み拡張機能の一覧にパッケージが表示されます。その横の Install(緑色の + ボタン)をクリックします。
3. Extensions > Extensions に移動し、拡張機能の種類で Shipping を選びます。VibeFox DPD Pickup を見つけて、Install(緑色の + ボタン)をクリックし、次に Edit(鉛筆ボタン)をクリックします。
4. OpenCart 3 の手順 4 と 5 と同じように、ライセンスキーと設定を入力します。設定ページとその項目は、両方のバージョンで同じです。
インストール後は、Enable/Disable を有効にして保存するまで、この方法は無効のままです。アンインストール後に拡張機能を再インストールすると、保持されていた設定が再び使われます。
設定
すべての設定は拡張機能のページにあります:Extensions > Extensions > Shipping > VibeFox DPD Pickup > Edit。セクションは左側に表示されます。1 つの Save ボタンで、ページを再読み込みせずにページ全体を保存します。保存のたびに、キャッシュされた受け取りポイントの一覧も消去されます。この拡張機能の変更権限を持つ管理者ユーザーのみが、設定の保存、受け取りポイントの更新、ログの消去を行えます。
ページ上部の警告は、DPD Baltic のユーザー名またはパスワードが空の場合、料金が 1 つも設定されていない場合(どちらの場合もチェックアウトに表示されません)、そしてストアに単位 kg の重量クラスがない場合(その場合、商品の重量は単位名で読み取られ、不明な単位は kg として扱われます)に表示されます。一部の値は保存を止めるため、その場合は何も保存されません。空または 64 文字を超える Name、整数ではない Sort order、Max weight (kg) より大きい Min weight (kg) が該当します。金額または重量の欄に数値でない値や負の値を入力した場合、その値は保存されず、欄は空になり、警告でその欄が示されます。他の設定は保存されます。CC:PRICE の形式に合わない Country prices の行は、警告に一覧表示され、無視されます。
一般
この方法は、Availability で設定されたジオゾーンで提供されます(未設定の場合はすべてのゾーン)。または、Ignore shipping zones を使い、そこで選んだ国で提供されます。
Enable/Disable: チェックアウトで DPD Pickup を表示または非表示にします。既定値: オフ。
Name: チェックアウトで購入者に表示される配送方法の名称。既定値: DPD Pickup Point。必須、64 文字以内。
Tax class: 配送料に適用される税クラス。税を適用しない場合は None(既定)を選びます。
Sort order: 配送方法の一覧での表示順。整数。
DPD 受け取りポイントの一覧
受け取りポイントは DPD から読み込まれ、キャッシュされます(チェックアウトでの動作を参照)。
DPD API: お客様のアカウントがある DPD の会社。Baltic のアカウントは、それぞれの国の Web サービスを使用します。
API username (Baltic): DPD Baltic Web サービスのユーザー名。DPD Slovakia では不要です。消去すると、保存済みのパスワードも消去されます。
API password (Baltic): DPD Baltic Web サービスのパスワード。DPD Slovakia では不要です。保存後、この欄は空のままで、Saved - leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。
Pickup points: Refresh pickup points ボタンはキャッシュを消去し、DPD から今すぐ受け取りポイントを読み込みます。Baltic API ではリトアニア、ラトビア、エストニア、DPD Slovakia ではブラチスラバでのテスト検索を行います。国ごとに、受け取りポイントの数またはエラーを表示します。先に設定を保存してください。
料金
配送料は国ごとの固定額で、ストアの既定通貨、税抜きで設定します。DPD の料金は API からは取得しません。
Country prices: 国ごとに 1 行、CC:料金の形式で入力します(例: EE:3.50)。小数点はカンマも使用できます。既定値: SK:3.50, LT:4.00, LV:4.00, EE:4.00。
Fallback cost: Country prices にない国の料金。既定値: 5.00。一覧の国だけでこの方法を提供する場合は空欄のままにします。
Calculation type: Per order(既定)は料金を 1 回だけ請求します。Per item (price x quantity) は、カート内の商品数を掛けた金額を請求します。
Free shipping from: 注文の小計(割引後、税抜き)がこの金額に達すると、配送料は無料になります。空欄にすると無効になります。
利用可否
DPD が購入者の住所に対して受け取りポイントを返さない場合や、DPD API に接続できない場合も、この方法は非表示になります。受け取りポイントがないと注文を配送できないためです。
Min weight (kg): カートの最小重量。商品の重量は重量クラスから換算されます。空欄または 0 の場合は制限なしです。
Max weight (kg): これより重いカートにはこの方法が表示されません。既定値: 31.5。空欄または 0 の場合は制限なしです。お住まいの国の DPD Pickup の受け取りポイントとロッカーの荷物の制限を確認してください。
Minimum subtotal: 注文の小計(割引後、税抜き)がこの金額以上の場合のみ、この方法を表示します。空欄にすると常に表示します。
Geo zone: このジオゾーン内の住所に対してのみ、この方法を提供します。All zones(既定)は制限なしを意味します。ジオゾーンは System > Localisation > Geo Zones で管理します。Ignore shipping zones と併用しません。
Ignore shipping zones: オンにすると、ジオゾーンは確認されず、以下の国でこの方法が提供されます。オフ(既定)の場合は、上記のジオゾーンのみが使われます。
Countries: このモードで対象となる配送先の国。すべての国を対象にする場合は空欄のままにします。Ignore shipping zones を使う場合にのみ使用されます。
受け取りポイントセレクター
City order: 主要な都市(Tallinn、Riga、Vilnius、Bratislava など)を先に表示します。既定でオンです。
City list width: 都市の一覧の CSS の幅(例: 100% または 300px)。既定値: 100%。
Pickup point list width: 受け取りポイントの一覧の CSS の幅(例: 100% または 400px)。既定値: 100%。
詳細設定
Debug log: API リクエストとチェックアウトの手順を storage/logs/vfd_dpd_debug.log.php(OpenCart 4 では system/storage/logs/vfd_dpd_debug.log.php)に書き込みます。このファイルは Web から読み取ることはできません。このオプションがオフでも、API のエラーは常に記録されます。認証情報は決して記録されません。ファイルが 5 MB に達すると、vfd_dpd_debug.old.log.php に移動され、新しいログが始まります。
Log: デバッグログのサイズと最新のエントリを表示します。Clear log をクリックすると内容を消去します。
Remove data on uninstall: オンにすると、拡張機能をアンインストールしたときに、拡張機能の設定、ログ、未完了のチェックアウトの選択が削除されます。注文に保存された受け取りポイントは、常に保持されます。
インポート / エクスポート
Export: Download JSON をクリックすると、設定を JSON ファイルとして保存します。API パスワードはエクスポートされません。
Import: 以前にエクスポートした JSON を貼り付けて Import をクリックすると、設定を復元します(例: 別のストアへの移行)。値は通常の保存時と同じように検証されます。保存済みの API パスワードは保持されます。
チェックアウトでの動作
OpenCart が配送方法を表示するとき、拡張機能に DPD Pickup の料金を問い合わせます。Geo zone が設定されていて(かつ Ignore shipping zones がオフ)、住所がそのゾーン外である場合、この方法は提供されません。Requires Shipping が Yes に設定された商品だけが計算に含まれます。それ以外の商品は重量を加算せず、小計にも含まれません。拡張機能は国(Ignore shipping zones の場合)、カートの重量、最低小計を確認し、その国の料金(または代替料金)を取得して、小計が十分に高ければ送料無料を適用します。小計は、クーポン割引後、税抜きの、配送が必要な商品の価格です。
次に、住所に対応する DPD の受け取りポイントを読み込みます。DPD がポイントを返さない場合、接続できない場合、または Baltic の認証情報がない場合、この方法は非表示になります。DPD Slovakia の場合は、都市または郵便番号がまだ入力されていなくても方法を表示し、住所が完成するとポイントが表示されます。料金はストアの既定通貨で計算され、購入者には、選択した Tax class の税額を含めて、購入者の通貨で表示されます。
受け取りポイントの一覧は最大 24 時間、空の一覧は最大 1 時間キャッシュされます。ただし、OpenCart のキャッシュ有効期間(既定では 1 時間)を超えることはありません。失敗したリクエストは 5 分間記録されるため、DPD の障害によってチェックアウトが遅くなることはありません。API のタイムアウトは 15 秒です。
本拡張機能は、DPD の料金を取得せず、DPD の配送を作成せず、ラベルを印刷せず、マニフェストを作成せず、宅配便の集荷を依頼せず、荷物を追跡せず、地図も表示しません。サポートされているのは DPD Baltic の Web サービスと DPD Slovakia の parcelshop 検索のみです。
受け取りポイント
購入者が DPD Pickup を選ぶと、この方法の下に都市の一覧と受け取りポイントの一覧が表示されます。購入者の住所の都市が初期選択されています。購入者が選択すると、その選択はすぐに保存されます。DPD Slovakia の場合、住所が完成するまで購入者には Enter your city and postcode to see the DPD pickup points nearby. と表示され、その後は近くのポイントが表示されます。DPD がその住所のポイントを 1 つも持っていない場合、購入者には No DPD pickup points are available for this address right now. Please check the address or choose another shipping method. と表示されます。
受け取りポイントの選択は必須です。選択しないと購入者は先に進めず、Please select a DPD pickup point. と表示されます。購入者が Continue をクリックすると、サーバーは、そのポイントが購入者の住所の DPD 一覧に属しているかを確認します。偽造された選択や古い選択は、The selected DPD pickup point is not available for this address. Please choose another one. と表示されて拒否されます。その時点で DPD の一覧を読み込めない場合は、購入者がすでに選んだポイントが受け入れられ、注文には名称ではなく ID が表示されます。
OpenCart 4 では、購入者はチェックアウトページの配送方法ブロックで Choose をクリックし、Shipping method options のウィンドウで DPD Pickup を選びます。都市の一覧と受け取りポイントの一覧は、そのウィンドウの方法の下に表示され、上で説明したとおりに動作します。ウィンドウの Continue ボタンは、受け取りポイントを選ばないと先に進まず、同じメッセージが表示されます。
選ばれた受け取りポイントは、注文の配送方法に追加されます。たとえば、既定のタイトルでは DPD Pickup Point: name, street, postcode city、独自のタイトルを設定している場合は My title - DPD pickup point: name, street, postcode city のように表示されます(128 文字以内)。これにより、管理画面の注文、購入者の注文履歴、注文メール、請求書に表示されます。注文に保存される名称は、ブラウザではなく DPD から取得されます。
OpenCart 4 では、配送方法のテキストは最大 255 文字まで使用できます。OpenCart 4 は、チェックアウト用の注文を 1 つ保持し、購入者が再度確定するたびにその注文を更新します。注文の受け取りポイントも、それに合わせて更新されます。
管理画面の注文ページ(Sales > Orders)では、履歴の上にある DPD pickup point パネルに、ポイント名、ID、国が表示されます。Edit をクリックし、都市と別のポイントを選んで Save をクリックします。ポイントは注文の住所に対する DPD の一覧と照合され、パネルには Pickup point updated. または Pickup point not found for the order address. と表示されます。注文の配送方法のテキストが更新され、注文履歴には、以前のポイント、新しいポイント、管理者ユーザーを記したメモ(購入者には送信されません)が追加されます。受け取りポイントを変更するには、拡張機能の設定へのアクセスではなく、注文の変更権限が必要です。DPD Slovakia の場合、注文には配送先の都市と郵便番号が必要です。そうでない場合、パネルには Add the shipping city and postcode to change the pickup point. と表示されます。ポイントを選ばずに行われた注文には No pickup point was selected for this order. と表示され、デバッグログにエラーが記録されます。このパネルと Edit は、拡張機能をオフにした後も利用できます。
ライセンスキー
本拡張機能は、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox DPD Pickup は、Extensions > Extensions > Shipping > VibeFox DPD Pickup > Edit ページの一番上、設定の上にあります。License key にキーを貼り付け、Activate をクリックします。その後、ブロックにはキーがマスクされた状態で表示され、ステータス(ライセンスの有効期限の日付やドメインなど)と、Check now(ステータスを再確認)、Change key(別のキーを入力)、Remove key(このストアからキーを削除)のボタンが表示されます。その下には Product: opencart-shipping-dpd-pickup の行と、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 のアカウントで解放してください。
有効なキーがない場合、DPD Pickup の配送方法はチェックアウトで購入者に表示されず、料金も計算されません。同じブラウザで管理画面にログインしている管理者ユーザーには、(unlicensed — visible to admins only) と表示された状態で、ストアに方法が表示されます。そのため、キーを購入する前に拡張機能を設定してテストできます。OpenCart 4 では、このプレビューは利用できません。ストアは管理画面のログイン状態を認識しないため、有効なキーがない場合は、全員に対して方法が非表示になります。Edit ページを一度開くと、管理画面の Dashboard にお知らせが表示されます。× で閉じると、7 日間非表示になります。既存の注文には影響しません。
ライセンスが期限切れになっても、拡張機能は動作し続けますが、更新やサポートを受けるには更新が必要です。管理画面の Dashboard または Edit ページを開くと、ステータスは自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日 1 回、その後は週 1 回確認されます。cron ジョブは必要ありません。拡張機能をアンインストールすると、ライセンスキーとライセンスの状態は常に削除されます。
トラブルシューティング
チェックアウトに DPD Pickup が表示されない: ライセンスが有効で、Enable/Disable がオンになっていることを確認してください。Geo zone(または Ignore shipping zones と Countries)、重量と小計の制限、国に料金(または代替料金)があるかを確認します。拡張機能のページ上部の警告を確認し、Refresh pickup points をクリックしてください。商品の Requires Shipping が Yes に設定されているかも確認します。
Refresh pickup points の後にエラーが表示される: 結果には国ごとの DPD のエラーが表示されます。たとえば "Login failed" は、DPD が Baltic の認証情報を拒否したことを意味し、そのため受け取りポイントを読み込めません。DPD で API のユーザー名とパスワードを確認してください。
DPD Slovakia にポイントが表示されない: ポイントは、購入者が都市と郵便番号を入力した後に表示されます。DPD は、その住所から 50 km 以内のポイントだけを一覧表示します。
原因の確認: Debug log をオンにして、チェックアウトを再読み込みし、拡張機能のページにある Log の欄を確認します。API のエラーは常に記録されます。API のユーザー名とパスワードがログに書き込まれることはありません。
変更後に受け取りポイントが古いように見える: 拡張機能のページで Save または Refresh pickup points をクリックします。どちらもキャッシュされた一覧を消去します。
ページに "Warning: You do not have permission to modify VibeFox DPD Pickup!" と表示される: 管理者のユーザーグループには、設定の閲覧権限しかない可能性があります。System > Users > User Groups で、そのグループに extension/shipping/vfd_dpd_pickup(OpenCart 3)または extension/vfd_dpd_pickup/shipping/vfd_dpd_pickup(OpenCart 4)の変更権限を付与してください。
開発者向け: DPD Slovakia の検索半径は、別の拡張機能が OpenCart のイベント vfd_dpd_pickup/sk_search_radius によって変更できます。
アンインストール
Extensions > Extensions に移動し、種類として Shipping を選び、VibeFox DPD Pickup の横にある Uninstall(赤い − ボタン)をクリックします。この拡張機能のライセンスキーとライセンスの状態は、常に削除されます。OpenCart は常に Enable/Disable、Sort order、Tax class、Geo zone をリセットします。拡張機能は常に、そのイベントとキャッシュされた受け取りポイントの一覧を削除します。Remove data on uninstall がオンの場合は、その他の設定、デバッグログ、未完了のチェックアウトの選択も削除されます。オフの場合は、設定が保持され、拡張機能を再インストールしたときに再び使用されます。注文に保存された受け取りポイントは決して削除されず、既存の注文は配送方法と料金を保持します。
OpenCart 4 で拡張機能のファイルも削除する場合は、アンインストール後に Extensions > Installer に移動し、インストール済み拡張機能の一覧で VibeFox DPD Pickup の横にある Uninstall(オレンジ色の − ボタン)をクリックしてから、Delete(赤いゴミ箱ボタン)をクリックして、アップロードしたパッケージを削除してください。
DPD は、それぞれの所有者の商標です。本拡張機能は DPD と提携しておらず、DPD による承認もありません。
