VibeFox Envioclick for PrestaShop — ヘルプ
要件
PrestaShop:8.0 から 9.x。
PHP:8.0 以降。モジュールは、それより古い PHP バージョンではインストールできません。
Envioclick アカウント(リアルタイムの料金のみ必要):メキシコまたはコロンビアの Envioclick アカウントで、API へのアクセスが有効なもの。API キーは Envioclick アカウントの Mi cuenta(右上)> Información del API にあります。固定料金のみを使用する場合、Envioclick アカウントは不要です。
User-Agent(メキシコのみ):Envioclick Mexico では、API へのすべてのリクエストに User-Agent の値が必要です。Envioclick サポート(soporte.tecnico@envioclick.com)にお問い合わせください。
VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ使用できます。
インストール
1. 管理画面で Modules > Module Manager に進み、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックします。後で行う場合は、モジュール一覧で VibeFox Envioclick を探し、Configure をクリックします。
3. Configure ページ上部のライセンスブロックの License key に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーを参照)。
4. API キーを入力し、API の国を選択します。User-Agent(メキシコ)、発送元の郵便番号または DANE コード、発送元住所を入力します。ストアのデフォルト通貨が MXN または COP でない場合は、通貨換算レートを入力します。コロンビアの場合、ページに表示される場合は Add Colombian departments をクリックします。
5. 必要に応じて、国ごとの固定料金とフォールバック料金を追加し、Save をクリックします。
インストール時、モジュールは Courier delivery by the best Envioclick carrier という配送日数テキストを持つ Envioclick Shipping 配送業者を作成します。配送業者はすべてのゾーンとすべての顧客グループに割り当てられます。ゾーン、顧客グループ、配送日数、ロゴ、サイズ制限は Shipping > Carriers で変更できます。ここで料金は設定しないでください。料金は常にモジュールから取得されます。
設定
すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox Envioclick > Configure。各セクションには個別の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Envioclick の見積もりもクリアされます。数値フィールドでは、小数点としてピリオドとカンマのどちらも使用できます。
API キーが設定されている場合、リアルタイムの料金が機能しない状況では、ページの上部に警告が表示されます。MXN または COP 以外のストア通貨に換算レートがない場合、メキシコに User-Agent がない場合、発送元の郵便番号または DANE コードがない場合、またはコロンビアに発送元住所がない場合です。ストアの重量単位または寸法単位が認識されない場合も警告されます。その場合は International > Localization(Local units)で、kg、g、lb、oz のいずれか、および cm、mm、m、in のいずれかを設定してください。保存時には、モジュールが次の点を確認します。Method title が有効な配送業者名であること、数値フィールドが負でない数値を含むこと、Currency conversion rate が 0 より大きいこと、Minimum weight が Maximum weight を超えないこと、そして発送元コードがメキシコでは 5 桁、コロンビアでは 8 桁(または 5 桁の自治体コード)であることです。確認に失敗した場合はエラーが表示され、何も保存されません。
一般
配送業者のゾーン、顧客グループ、サイズ制限は Shipping > Carriers で設定します(または、下の Ignore shipping zones を使用します)。このページの設定はすべてのゾーンに適用されます。
Enable Envioclick:配送業者をオンまたはオフにします。これは Shipping > Carriers の配送業者のステータスと同じスイッチです。
Method title:カートとチェックアウトで購入者に表示される配送業者名です。デフォルト:Envioclick Shipping。必須。
Carrier in the title:リアルタイムの料金の Envioclick 配送業者と配送予定日を、チェックアウトの配送業者名の下に表示します。例:「Estafeta Express, 1 day」。この設定に関係なく、配送業者は注文に保存され、注文ページに表示されます。デフォルト:オン。
Envioclick API(リアルタイムの料金)
任意です。API キーがない場合は、固定料金のみが使用されます。このセクションには、メキシコとコロンビア向けの Envioclick API ドキュメントへのリンクがあります。リアルタイムの料金は、API の国の宛先についてのみ請求されます。その他の国への発送には固定料金が使用されます。
API key:Envioclick の API キーです。Mi cuenta > Información del API で確認できます。「Authorization」ヘッダーで送信されます。保存後、このフィールドは空になり、Saved — leave empty to keep it と表示されます。変更する場合にのみ新しい値を入力してください。
Remove the saved API key:保存されたキーがある場合にのみ表示されます。Yes を選択して保存するとキーが削除され、以後は固定料金のみが使用されます。API key に入力したキーは、保存済みのキーを置き換えます。
API country:Envioclick アカウントの国です。
Colombian departments:コロンビアのみ。PrestaShop には、デフォルトではコロンビアの県がありません。県がない場合、コロンビア国内で一意の市区町村名のみが認識されます。県は、同名の自治体を区別するために使われます。Add Colombian departments ボタンを押すと、33 の県がコロンビアの州として追加されます(ISO コード ANT、DC など)。また、コロンビアで「Contains states」が有効になり、コロンビアの住所フォームに県のフィールドが追加されます。既に存在する県は二重に追加されません。すべての設定が完了すると、フィールドにコロンビアの住所が持つ県の数が表示されます。
User-Agent(メキシコ):Envioclick サポートから発行された値です(soporte.tecnico@envioclick.com)。例:EcUserAgent-2/123456。メキシコでは必須です。これがない場合、メキシコ向けのリアルタイムの料金は請求されません。コロンビアでは任意です。
配送業者の選択:Cheapest(デフォルト)または Fastest (then cheapest)。Envioclick は複数の配送業者から見積もりを返し、購入者は 1 つの料金を受け取ります。
営業所受け取りの料金:購入者が配送業者の営業所で荷物を受け取る「Ocurre」の料金も考慮します。オフの場合は、宅配の料金のみが使用されます。代金引換(COD)サービスは使用されません。デフォルト:オフ。
通貨換算レート:Envioclick は MXN(メキシコ)または COP(コロンビア)で見積もります。ストアのデフォルト通貨が異なる場合は、1 MXN または 1 COP の価値を、ストアの通貨で入力してください。例:0.05。申告された荷物の価格も同じ方法で換算されます。ストアの通貨が MXN または COP の場合は、空欄のままにします。レートがない場合、別の通貨ではリアルタイムの料金は使用されません。
発送元
リアルタイムの料金に使用されます。空欄のフィールドは、ストアが API の国にある場合、Shop Parameters > Contact > Stores のストア住所から取得されます。
Origin postcode / DANE code:メキシコ:5 桁の郵便番号。コロンビア:自治体の 8 桁の DANE コード(例:ボゴタは 11001000)。5 桁の自治体コード(11001)も使用できます。
Origin address:集荷先住所の番地と番号です。コロンビアでは必須で、メキシコでは任意です。
固定料金
リアルタイムの料金がない場合に使用されます。API キーがない場合、宛先が API の国の外にある場合、API のエラーが発生した場合、またはルートに配送業者がない場合です。
Price per country:2 文字の国コードと、ストアのデフォルト通貨での料金(税抜き)の表です。Add row をクリックすると国を追加でき、ゴミ箱のアイコンをクリックすると削除できます。独自の行を持たないすべての国には、国コードとして * を使用します。
Fallback cost:リアルタイムの料金がなく、表のどの行も一致しない場合に使用されます。この場合に配送業者を非表示にするには、空欄のままにします。
Fixed price applies:Per order は料金を 1 回だけ請求します。Per item (price × quantity) は、カート内の商品数を掛けた料金を請求します。Envioclick のリアルタイムの料金は、常に 1 個口ごとです。
条件
Minimum weight:カートの重量がこの値未満の場合に配送業者を非表示にします。単位は kg です。0 は制限なしを意味します。
Maximum weight:カートの重量がこの値を超える場合に配送業者を非表示にします。単位は kg です。デフォルト:25。0 は制限なしを意味します。
Minimum order amount:カートの小計(割引後、税抜き)がこの金額以上の場合にのみ配送業者を表示します。常に表示するには空欄のままにします。
Free shipping from:カートの小計(割引後、税抜き)がこの金額に達すると、送料無料になります。この場合、Envioclick へのリクエストは行われません。送料無料を一切提供しない場合は、空欄のままにします。
Tax:配送業者の税ルール、または No tax です。Envioclick の見積もりには、配送業者の税がすでに含まれています。そのため、送料に税金が二重に課されないように No tax を選択してください。
配送ゾーンなしでの提供
通常、配送業者は Shipping > Carriers で割り当てられたゾーンで提供されます。
Ignore shipping zones:配送業者がそのゾーンに割り当てられていなくても、下記の国に対して Envioclick を提供します。オンにすると、配送業者は後から作成されたゾーンも含め、すべてのゾーンに割り当てられます。オフにすると、配送業者は以前のゾーンを取り戻します。
Countries:このモードでの宛先の国です。空欄にすると、発送先のすべての国(有効な国)が使用されます。Ignore shipping zones がオンの場合にのみ使用されます。
詳細
Debug log:料金計算と API のエラーを、モジュールフォルダー内の logs/vfd_evc_debug.log.php に記録します。このファイルは Web から開くことはできません。API キーと購入者の住所は記録されません。ログがオフの間は、何も書き込まれません。作業が終わったらオフにしてください。
Log:デバッグログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログが空になります。
Remove data on uninstall:オンの場合、モジュールをアンインストールすると、Envioclick の設定、配送業者、キャッシュされた見積もり、ログが削除されます。過去の注文で保存された配送業者は保持されます。オフの場合、再インストールに備えてすべて保持されます。
チェックアウト時の動作
配送のステップで、PrestaShop はモジュールに Envioclick の料金を問い合わせます。対象となるのは物理的な商品のみです。バーチャル商品は重量に加算されず、注文金額にも含まれません。モジュールはまず条件を確認します。Ignore shipping zones の国、カートの重量、最低注文金額です。送料無料が適用される場合、料金は 0 になり、Envioclick へのリクエストは送信されません。
API キーが設定されていて、宛先が API の国にある場合、モジュールは Envioclick に見積もりを求めます。メキシコでは、購入者が 5 桁の郵便番号を入力すると、リクエストが行われます。コロンビアでは、県と自治体が認識されるとリクエストが行われます(アクセント記号と大文字・小文字は区別されません)。モジュールは、代金引換ではない最安または最速の見積もりを選び、それをストアのデフォルト通貨に換算します。料金は購入者のカートの通貨で表示されます。
荷物は常に 1 つの箱として扱われます。合計重量を kg に換算し、最大の商品の縦と横の寸法を使い、すべての商品の合計体積を収容できる高さを使用します。寸法のない商品は 10 × 10 × 10 cm として計算されます。重量のないカートは、0.5 kg として送信されます。申告価格はカートの小計です。
同じルートと同じ荷物の見積もりは、1 時間キャッシュされます。リクエストが失敗した場合は 10 分間キャッシュされるため、利用できない API がチェックアウトの更新のたびに遅くなることはありません。API のタイムアウトは 10 秒です。Envioclick がエラーを返す場合、またはルートに配送業者がない場合、購入者にはエラーは表示されません。固定料金が使用されるか、配送業者が非表示になります。その理由はデバッグログに記録されます。
注文がある配送業者を Shipping > Carriers で編集すると、PrestaShop はそれを新しいバージョンの配送業者として保存します。モジュールは新しいバージョンに自動的に従います。
モジュールは料金の計算のみを行います。送り状やラベルの作成、集荷の依頼、配送状況の追跡やキャンセルは行いません。配送業者の選択肢ではなく、料金を 1 つ提示します。代金引換サービスや複数個口の見積もりは使用しません。リアルタイムの見積もりは国内のみです。
注文
Envioclick の配送業者で注文が行われると、そのカートについて計算された料金が注文とともに保存され、以後変更されません。管理画面の注文ページには、Envioclick shipping ブロックが表示されます。このブロックには、Envioclick carrier、Estimated delivery、Envioclick rate ID(リアルタイムの料金の場合)、Price source(Envioclick live rate、Fixed price per country、Fallback cost、Free shipping threshold)、Calculated price (excl. tax) が含まれます。リアルタイムの料金の場合、購入者の注文ページには Shipping carrier が表示されます。送り状は Envioclick アカウントで作成してください。
固定料金で行われた注文には、Envioclick の配送業者はありません。
ライセンスキー
モジュールは、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox Envioclick は、Modules > Module Manager > VibeFox Envioclick > Configure の最初のブロックで、設定の上にあります。キーを License key に入力し、Activate をクリックします。その後、ブロックにはキーが一部隠された状態で表示され、ステータス(ライセンスの有効期限の日付やドメインなど)と、ボタンが表示されます:Check now でステータスを再確認、Change key で別のキーを入力、Remove key でこのストアからキーを削除します。その下には Product: presta-shipping-envioclick の行と、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 のアカウントで解放してください。
有効なキーがない場合、Envioclick の配送業者はチェックアウト時に購入者に表示されず、料金も計算されません。PrestaShop のストアフロントはバックオフィスにログインしていることを認識しないため、配送業者はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文は影響を受けません。
ライセンスの有効期限が切れてもモジュールは動作を続けますが、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キーを入力後の最初の 14 日間は 1 日に 1 回、その後は週に 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
チェックアウトに Envioclick が表示されない:ライセンスが有効であり、Enable Envioclick がオンになっていることを確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと購入者のグループをカバーしていることを確認するか、Ignore shipping zones をオンにして Countries を確認してください。重量制限と Minimum order amount も確認してください。リアルタイムの料金がない場合、配送業者にはその国の固定料金、* の行、または Fallback cost が必要です。商品ページで、商品が特定の配送業者に限定されている場合もあります。
リアルタイムの料金が表示されない:モジュールのページ上部の警告を確認してから、Debug log をオンにし、チェックアウトを再読み込みして、モジュールのページの Log フィールドを確認してください。よくある原因は次のとおりです。換算レートがない(ストアの通貨が MXN または COP ではない)、User-Agent がない(メキシコ)、発送元の郵便番号または DANE コードがない、購入者の郵便番号(メキシコ)または市区町村(コロンビア)がまだ入力されていない、宛先が API の国の外にある、またはルートに配送業者がない。
なぜ換算レートが必要なのですか?Envioclick はメキシコまたはコロンビアのペソでのみ料金を返します。モジュールは、ペソの金額を別の通貨として表示することはありません。
コロンビア:市区町村が認識されない:購入者が県を選択できるように、モジュールのページで Add Colombian departments をクリックし、市区町村名が正しく入力されているか確認してください。郵便番号として入力された 8 桁の DANE コードも使用できます。
配送料に税金が二重にかかる:Envioclick の見積もりには、配送業者の税がすでに含まれています。Tax を No tax に設定してください。
変更後、料金が古いようだ:モジュールのページで Save をクリックしてください。これにより、キャッシュされた見積もりがクリアされます。
Envioclick の配送業者が見つからないと表示される:配送業者が Shipping > Carriers で削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。
アンインストール
Modules > Module Manager に移動し、VibeFox Envioclick の横にあるメニューを開いて、Uninstall を選択してください。ライセンスキーとライセンスステータスは常に削除されます。キャッシュされた見積もりと、注文のないカートの保存済み料金は、常に削除されます。Remove data on uninstall がオンの場合、配送業者は削除され(注文は履歴を保持します)、設定とログも削除されます。オフの場合、配送業者はオフになるだけで、すべての設定は保持されます。モジュールを再インストールすると、保存されていた配送業者は以前のステータスに戻ります。どちらの場合も、注文済みの Envioclick のデータは保持されます。
Envioclick は、その所有者の商標です。このモジュールは Envioclick とは提携しておらず、Envioclick の承認も受けていません。
