VibeFox Delhivery for PrestaShop — ヘルプ
要件
PrestaShop: 8.0~9.x。
PHP: 8.0 以降。モジュールは古い PHP バージョンへのインストールを拒否します。
Delhivery API トークン(リアルタイム料金の場合のみ): Delhivery One にログインし、Settings > API setup を開きます。Delhivery のヘルプ記事「API token generation」に手順が説明されています。どちらのリンクもモジュールページにあります。テスト用トークンはステージング環境で使用できます。また、集荷場所の 6 桁の PIN コードも必要です。固定料金のみを使用する場合、トークンは不要です。
VibeFox ライセンスキー: vibefox.net で購入します。1 つのキーは 1 つのドメインで使用できます。
インストール
1. 管理画面で Modules > Module Manager に移動し、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックします。後で VibeFox Delhivery をモジュール一覧から探して Configure をクリックすることもできます。
3. Configure ページ上部のライセンスブロックの License key に VibeFox ライセンスキーを入力し、Activate をクリックします(「ライセンスキー」を参照)。
4. API トークンと出荷元 PIN コードを入力し、Express または Surface、および Pre-paid または COD を選択します。ストアのデフォルト通貨が INR でない場合は、為替レートを入力します。必要に応じて固定料金も入力できます(「設定」を参照)。Save をクリックします。
インストール時に、モジュールは配送業者 Delhivery を作成します。配送日数のテキストは Courier delivery (India)、追跡 URL は Delhivery の追跡ページになります。配送業者はすべてのゾーンとすべての顧客グループに割り当てられます。ゾーン、顧客グループ、配送日数のテキスト、ロゴ、サイズ制限は Shipping > Carriers で変更できます。そこでは料金を設定しないでください。料金は常にモジュールから取得されます。
設定
すべての設定はモジュールページにあります:Modules > Module Manager > VibeFox Delhivery > Configure。設定はすべてのゾーンに適用されます。各セクションには個別の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Delhivery の料金も消去されます。金額は「9.99」と「9,99」のどちらも入力できます。数値フィールドに 0 以上の数値が入力されていない場合はエラーが表示され、何も保存されません。
ストアのデフォルト通貨が INR ではなく、API トークンは保存されているものの為替レートが未設定の場合、フォームの上に警告が表示され、為替レートを入力するまでリアルタイム料金は使用されないことが示されます。ストアの重量単位が標準単位(kg、g、lb、oz)でない場合は、International > Localization(Local units)で設定するよう警告が表示されます。設定しないと、商品の重量はキログラムとして扱われます。
一般
Enable Delhivery: 配送業者を有効または無効にします。これは Shipping > Carriers の配送業者のステータスと同じスイッチです。
Method title: カートとチェックアウトに表示される配送業者名。デフォルト: Delhivery。必須、最大 64 文字。
Tax: 配送業者の税ルール、または No tax。ルールがある場合、PrestaShop は配送料に税金を加算します。
Delhivery API アカウント(リアルタイム料金の場合のみ必要)
Environment: Production (track.delhivery.com)(デフォルト)または Staging / test account (staging-express.delhivery.com)。Staging は Delhivery のテスト用トークンを使用する場合にのみ選択してください。
API token: Delhivery の API トークンです。認証ヘッダーでのみ送信され、ログには一切記録されません。保存後、このフィールドは空になり、Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。
Remove saved token: オンにして保存すると、保存されたトークンが削除されます。その後は固定料金のみが使用されます。
Origin pincode: 集荷場所または倉庫の 6 桁の PIN コード(例: 110001)。6 桁でない場合は警告が表示され、修正されるまでリアルタイム料金は要求されません。
リアルタイム料金
有効な 6 桁の PIN コードを持つインドの配送先に対して、順方向(配達)の出荷について、リアルタイム料金が要求されます。
Shipping mode: 料金の計算に使用される Delhivery の請求モード:Express(デフォルト)または Surface。
Payment type: Delhivery に送信される支払いタイプ:Pre-paid(デフォルト)または COD (cash on delivery — Delhivery adds its COD charge)。モジュールは、お客様が選択した支払い方法に応じてこの設定を切り替えません。
Rate amount: Delhivery は GST 込みと GST 抜きの両方の金額を返します。
INR to (shop currency) conversion rate: ラベルにはストアのデフォルト通貨が表示されます。Delhivery の料金はインドルピー建てです。デフォルト通貨が INR でない場合は、1 ルピーがご利用の通貨で何単位に相当するかを入力してください(例: 0.011)。レートは 0 より大きい値である必要があります。空欄のままにするとリアルタイム料金は使用されず、固定料金が適用されます。デフォルト通貨が INR の場合は不要です。
固定料金(リアルタイム料金が利用できない場合に使用)
固定料金は、トークンや PIN コードがまだ設定されていない場合、配送先がインド国外の場合、PIN コードが配送対象外の場合、または API がエラーを返した場合に使用されます。料金はストアのデフォルト通貨で、税金を除いて設定します。
Prices per country: 1 行に 1 件、COUNTRY_CODE:price の形式で入力します(例: IN:120)。予備料金より先に確認されます。別の形式の行は保存時に破棄され、警告に一覧が表示されます。
Fallback price: リアルタイム料金も国別料金も適用されない場合に使用されます。配送業者を非表示にするには空欄にします。0 は無料を意味します。
Fixed price is charged: Per order は料金を 1 回だけ請求します。Per item (price × quantity) はカート内の商品数を掛けて請求します。Delhivery のリアルタイム料金は、常に荷物全体の重量に対するものです。
条件
Free shipping from: カートの小計(配送が必要な商品、割引適用後、税金適用前)がこの金額以上の場合、配送は無料です。Delhivery へのリクエストは送信されません。無効にするには空欄のままにします。
Show from subtotal: カートの小計がこの金額以上の場合にのみ配送業者を表示します。常に表示するには空欄のままにします。
Min weight: 配送業者を表示するための、カートの最小重量(kg)です。0 は制限なしを意味します。
Max weight: カートがこの重量(kg)より重い場合、配送業者を非表示にします。デフォルト: 30。0 は制限なし、空欄は 30 kg を意味します。Min weight は Max weight より大きくできません。大きい場合はページにエラーが表示され、何も保存されません。
商品の重量は、ストアの重量単位から kg に換算されます。料金はカートの実重量(商品重量の合計)に基づき、容積重量や箱は考慮されません。
配送ゾーンなしの利用可否
Ignore zones: オフの場合、国は Shipping > Carriers で配送業者に設定されたゾーンによって決まります。オンの場合、配送業者はすべてのゾーン(後で作成するゾーンを含む)に関連付けられ、下記の国に対して提供されます。オフにすると、配送業者は以前のゾーンに戻ります。
Countries: このモードの配送先の国です。有効な国の中から選択します。空欄のままにすると、配送可能なすべての国が対象になります。Ignore zones がオンの場合にのみ使用されます。
詳細設定
Debug log: 料金計算の記録を、モジュールフォルダ内の logs/vfd_dlv_debug.log.php に書き込みます。このファイルは Web からは開けません。API のエラーは、この設定がオフでも常に記録されます。トークンやお客様の完全な PIN コードは記録されません。
Log: ログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログが空になります。
Remove data on uninstall: オンの場合、モジュールをアンインストールすると、Delhivery の設定、配送業者、キャッシュされた料金、注文データ、ログが削除されます。オフの場合、再インストールに備えてすべてが保持されます。注文の AWB 番号は決して削除されません。
チェックアウトでの動作
配送のステップで、PrestaShop はモジュールに Delhivery の料金を問い合わせます。対象になるのは物理的な商品だけです。バーチャル商品は重量に加算されず、小計にも含まれません。モジュールはまず国(Ignore zones がオンの場合)、カートの重量、Show from subtotal を確認します。送料無料が適用される場合、料金は 0 になり、Delhivery へのリクエストは送信されません。
有効な 6 桁の PIN コードを持つインドの住所の場合、モジュールは Delhivery に、出荷元と配送先の PIN コード、カートの重量(グラム単位)、配送モード、支払いタイプを送信します。返された金額は INR からストアのデフォルト通貨に換算され、その後お客様のカートの通貨で表示されます。各応答は 1 時間キャッシュされます。失敗したリクエストは 10 分間キャッシュされるため、チェックアウトの更新のたびに Delhivery の応答を待つことはありません。API のタイムアウトは 10 秒です。
リアルタイム料金がない場合は、国別料金または予備料金が使用されます。どちらも設定されていない場合、配送業者は非表示になります。お客様に API のエラーが表示されることはありません。理由はログに記録されます。
注文がある配送業者を Shipping > Carriers で編集した場合、PrestaShop はそれを新しいバージョンの配送業者として保存します。モジュールは新しいバージョンに自動的に従います。
モジュールは料金を計算し、お客様に追跡リンクを提供します。出荷データや送り状の作成、ラベルの印刷、集荷やマニフェストの依頼、PIN コードの配送可否の確認、配達日の見積もり、追跡ステータスの同期、Delhivery の国際料金の見積もりは行いません。インド国外では固定料金のみが使用されます。
注文と追跡
Delhivery を使って注文が行われると、モジュールは配送モードと料金の取得元を注文とともに保存します。管理画面の注文ページでは、Delhivery ブロックに Mode:(Express または Surface)、Price:(Delhivery のリアルタイム料金、固定料金、または送料無料の基準額)、Delhivery AWB / tracking number が表示されます。未入力の場合は Not entered yet. と表示されます。
Delhivery One で出荷を作成し、その AWB 番号を注文ページの Carriers ブロック(Edit)で注文の追跡番号として入力します。すると Delhivery ブロックに Track on delhivery.com リンクが表示されます。お客様は注文履歴で追跡リンクを確認でき、PrestaShop から「配送中」ステータスのメールを受け取ります。
ライセンスキー
モジュールは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox Delhivery は、Modules > Module Manager > VibeFox Delhivery > Configure ページで設定の上にある最初のブロックです。キーを License key に入力し、Activate をクリックしてください。その後、ブロックにはキーがマスクされて表示され、ステータス(例えばライセンスの有効期限日とドメイン)と、ステータスを再確認する Check now、別のキーを入力する Change key、このストアからキーを削除する Remove key のボタンが表示されます。その下には Product: presta-shipping-delhivery の行と、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 のアカウントで解放してください。
有効なキーがない場合、チェックアウトで Delhivery の配送業者はお客様に表示されず、料金も計算されません。PrestaShop のストアフロントは、管理画面にログインしていることを認識しないため、配送業者はあなたにも表示されません。購入前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブに通知が表示されます。既存の注文には影響しません。
ライセンスの有効期限が切れてもモジュールは動作を続けますが、アップデートとサポートには更新が必要です。ステータスは、管理画面での作業中に自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
チェックアウトに Delhivery が表示されない: ライセンスが有効であることと、Enable Delhivery がオンであることを確認してください。Shipping > Carriers で、配送業者がお客様の国のゾーンとお客様の顧客グループをカバーしているか確認するか、Ignore zones をオンにして Countries を確認してください。重量制限と Show from subtotal も確認します。リアルタイム料金がない場合は、国別料金または Fallback price が必要です。商品ページで、特定の配送業者のみに商品を制限することもできます。
リアルタイム料金が表示されない: API トークン、有効な Origin pincode、そしてデフォルト通貨が INR でない場合は為替レートを確認してください。お客様は有効な 6 桁のインド PIN コードを入力する必要があります。Debug log をオンにし、チェックアウトを再読み込みして、モジュールページの Log フィールドを確認してください。配送対象外の PIN コードや Delhivery からの HTTP エラーなど、理由が表示されます。
GST が二重に課税される: Delhivery の合計金額にはすでに GST が含まれています。Rate amount を Gross amount (excluding GST) に設定するか、Tax を No tax に設定してください。
テスト: Environment を Staging に設定し、Delhivery のテスト用トークンを使用してください。
変更後に料金が古く見える: モジュールページで Save をクリックしてください。キャッシュされた Delhivery の料金が消去されます。
Delhivery の配送業者が見つからないと表示される: Shipping > Carriers で配送業者が削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。
開発者向け: モジュールは actionVfdDlvApiUrl と actionVfdDlvApiTimeout のフックを実行します。これらを使って、API のアドレスとタイムアウトを変更できます。
アンインストール
Modules > Module Manager に移動し、VibeFox Delhivery の横にあるメニューを開いて Uninstall を選択します。ライセンスキー、ライセンスステータス、キャッシュされた料金は常に削除されます。Remove data on uninstall がオンの場合、配送業者は以前のゾーンに戻って削除されます(注文の履歴は残ります)。また、設定、ログ、注文の Delhivery データ(モードと料金の取得元)が削除されます。オフの場合、配送業者は無効化されるだけで、すべての設定が保持されます。モジュールを再インストールすると、配送業者は以前のステータスで復元されます。AWB 番号は注文に残ります。
Delhivery は各所有者の商標です。本モジュールは Delhivery と提携しておらず、Delhivery の承認も受けていません。
