戻る

VibeFox Frenet for PrestaShop — ヘルプ

要件

PrestaShop:8.0 から 9.x。

PHP:8.0 以降。古いバージョンの PHP ではモジュールをインストールできません。

Frenet アカウント(リアルタイム見積もりのみに必要):Frenet パネル(painel.frenet.com.br)で無料アカウントを作成し、使用する配送業者を有効にして、API トークンをコピーしてください。固定料金のみを使用する場合、Frenet アカウントは不要です。

商品:正確な料金を得るために、重量と寸法を入力してください。入力がない商品は 0.3 kg と 16 × 11 × 2 cm(Correios の最小の箱)として見積もられます。

VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ使用できます。

インストール

1. 管理画面で Modules > Module Manager に移動し、Upload a module をクリックします。モジュールの ZIP ファイルを選択してください。

2. アップロードが完了したら Configure をクリックします。後で探す場合は、モジュール一覧で VibeFox Frenet を見つけて Configure をクリックしてください。

3. VibeFox ライセンスキーを、Configure ページ上部のライセンスブロックにある License key に貼り付け、Activate をクリックします(ライセンスキーを参照)。

4. API トークンを貼り付け、発送元の CEP を入力します。ショップのデフォルト通貨が BRL でない場合は、BRL の為替レートを入力します。必要に応じて固定料金と代替送料も追加できます。Save をクリックしてください。

インストール時、モジュールは配送日数のテキスト Delivery by the carriers of your Frenet account を付けて Frenet 配送業者を作成します。この配送業者はすべてのゾーンとすべての顧客グループに割り当てられます。ゾーン、顧客グループ、配送日数、ロゴ、サイズ制限は Shipping > Carriers で変更できます。料金はそこで設定しないでください。料金は常にモジュールから取得されます。

設定

すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox Frenet > Configure。設定は配送業者のすべてのゾーンに適用されます。各セクションには専用の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Frenet の見積もりも消去されます。料金の入力欄では、小数点とカンマのどちらも小数点区切りとして使えます。数値でない値は、"…" must be a number. というメッセージで拒否されます。負の金額や重量、0 以下の BRL exchange rate、Maximum weight より大きい Minimum weight も拒否されます。エラーがある場合は、何も保存されません。

ページ上部には、モジュールによる警告が表示されます。API トークンがない(固定料金のみ使用されます。固定料金もなければ、配送業者は表示されません)、8 桁の発送元 CEP がない、またはデフォルト通貨が BRL 以外で為替レートがない場合です。ショップの重量または寸法の単位をモジュールが認識できない場合も警告されます。そのような単位は kg または cm として扱われます。International > Localization(Local units)で標準の単位(kg、g、lb、oz、または cm、mm、m、in)を設定してください。

一般

Enable Frenet:配送業者をオンまたはオフにします。これは Shipping > Carriers の配送業者の状態と同じスイッチです。

Method title:カートとチェックアウトに表示される配送業者名です。デフォルト:Frenet。必須で、64 文字以内です。

Frenet のリアルタイム見積もり

Frenet は、Frenet アカウントで有効になっている配送業者を比較し、カートに対する料金を返します。リアルタイム見積もりは、ブラジルの住所で 8 桁の CEP が完全に入力されている場合にのみ要求されます。このセクションには Frenet パネルへのリンクがあります。

API token:Frenet パネルから取得した Frenet の API トークンです。固定料金のみを使用する場合は空欄のままにします。保存後、この欄は空のままになり、A token is saved — leave empty to keep it. と表示されます。値を変更する場合にのみ、新しい値を入力してください。保存されたトークンを削除するには、Remove the saved token にチェックを入れて保存します。

Origin CEP:荷物を発送する CEP(郵便番号)です。例:00000-000。ショップの住所がブラジルにある場合は、空欄のままにすると Shop Parameters > Contact > Stores のショップの郵便番号が使われます。8 桁未満の CEP は入力どおりに保存され、ページには Frenet: the origin CEP must have 8 digits. と表示されます。

Service to offer:Cheapest service(デフォルト)または Fastest service。Frenet は複数のサービスを返しますが、配送業者は 1 つの料金だけを表示します。

BRL exchange rate:Frenet はブラジルレアル建てで見積もります。ショップのデフォルト通貨が BRL でない場合は、デフォルト通貨で 1 BRL がいくらになるかを入力します。例:0.16。見積もりと申告された注文金額は、この為替レートで換算されます。為替レートがない場合、リアルタイム見積もりは使用されません。デフォルト通貨が BRL の場合、この欄には Not needed (shop currency is BRL) と表示されます。

固定料金

API トークンがない場合、Frenet がサービスを提供していない国の場合、および Frenet が料金を返さない場合(API が停止している、CEP がサービス対象外など)に使用されます。

Price per country:列 Country、Price、XS、S、M、L、XL を持つ表です。料金はデフォルト通貨で、税抜きで入力します。Add country をクリックすると行が追加され、ゴミ箱のアイコンをクリックすると行が削除されます。サイズの列はカートの重量によって決まります。XS は 1 kg 以下、S は 2 kg 以下、M は 3 kg 以下、L は 5 kg 以下、XL は 5 kg 超です。サイズの列が空の場合は Price が使用されます。Price が 0 の場合、その国は送料無料になります。その他のすべての国には * Default を使用します。料金がどの欄にも入力されていない行は、保存時に削除されます。

Fallback cost:Frenet も表も料金を返さない場合に使用されます。配送業者を非表示にするには空欄のままにします。

Fixed price applies:Per order は料金を 1 回だけ請求します。Per item (price × quantity) は、料金に商品数を掛けます。これは固定料金と代替送料にのみ適用されます。Frenet の見積もりは、すでにカート全体を対象としています。

条件

Minimum weight:カートの重量がこの値未満の場合、配送業者を非表示にします。単位は kg です。0 は制限なしを意味します。

Maximum weight:カートの重量がこの値を超える場合、配送業者を非表示にします。単位は kg です。デフォルト:30(欄が空の場合にもこの値が使われます)。0 は制限なしを意味します。Minimum weight より小さくすることはできません。

Minimum order amount:カートの小計(割引後、税抜き)がこの金額以上の場合にのみ、配送業者を表示します。常に表示する場合は空欄のままにします。

Free shipping from:カートの小計(割引後、税抜き)がこの金額以上の場合、送料が無料になります。送料無料を設定しない場合は空欄のままにします。

Tax:配送業者の税ルール、または No tax です。Frenet の料金は配送業者の最終料金です。PrestaShop がこれらに税を加算してはいけない場合は、No tax を選択してください。

商品の重量と寸法は、ショップの単位から kg と cm に換算されます。

配送ゾーンを使わない場合の提供

通常、配送業者は Shipping > Carriers で割り当てられたゾーンで提供されます。

Ignore shipping zones:どのゾーンが一致するかに関係なく、以下の国に対して Frenet を提供します。保存すると、配送業者はすべてのゾーンに追加され、後から作成されたゾーンにも追加されます。この設定をオフに戻すと、配送業者は以前のゾーンを取り戻します。

Countries:このモードの配送先の国です。ショップで有効な国の中から選択します。空欄のままにすると、配送しているすべての国が対象になります。Ignore shipping zones がオンの場合にのみ使用されます。

詳細設定

Debug log:見積もりのすべてのリクエストとレスポンスを、モジュールフォルダ内の logs/vfd_frn_debug.log.php に記録します。このファイルは Web から開くことはできません。API のエラーは常に記録されます。トークンは記録されず、お客様の CEP は短縮されます。作業が終わったらオフにしてください。

Log:ログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログが空になります。

Remove data on uninstall:オンの場合、モジュールをアンインストールすると、すべての Frenet 設定、配送業者、ログが削除されます。オフの場合、再インストールに備えてすべてが保持されます。キャッシュされた見積もりは常に削除されます。注文とともに保存された Frenet のサービスは注文履歴であり、保持されます。

チェックアウト時の動作

配送のステップで、PrestaShop はモジュールに Frenet の料金を問い合わせます。対象になるのは物理的な商品のみです。バーチャル商品は重量に加算されず、注文金額にも含まれません。お客様が住所を入力する前は、ショップが訪問者について推定した国を使用します。モジュールはまず国のリスト(Ignore shipping zones がオンの場合)、カートの重量、最低注文金額を確認します。送料無料が適用される場合、料金は 0 になり、Frenet へのリクエストは送信されません。

8 桁の CEP が完全に入力されたブラジルの住所では、モジュールは発送元と配送先の CEP、カート内の各商品(重量(kg)、寸法(cm)、数量、商品の参照番号、カテゴリ)、BRL で表した注文金額、カートの最初のクーポンコードを Frenet に送信します。CEP が未入力の間はリクエストを行いません。Frenet は、有効な配送業者のサービスを返します。エラーのあるサービスや料金のないサービスは除外されます。モジュールは最安または最速のサービスを選択し、料金をデフォルト通貨に換算します。その後、料金はお客様のカートの通貨で表示されます。

各応答は、同じカートと住所について 1 時間キャッシュされます。リクエストに失敗した場合、または有効な配送業者がいずれもサービスを提供していない CEP の場合は、10 分間記憶されます。API のタイムアウトは 10 秒です。これらの場合、お客様にエラーは表示されません。固定料金または代替送料が使われるか、どちらもない場合は配送業者が非表示になります。理由はログに記録されます。ブラジル以外の住所では、固定料金のみが使用されます。

注文がある配送業者を Shipping > Carriers で編集すると、PrestaShop はそれを新しいバージョンの配送業者として保存します。モジュールは新しいバージョンに自動的に追従します。

モジュールが行うのは料金の計算のみです。送り状の作成、ラベルの印刷、荷物の追跡は行いません。カートごとに Frenet のサービスは 1 つだけ表示され、複数は表示されません。受け取りポイントやロッカーにも対応していません。Frenet の見積もりはブラジル国内のみです。他の国では固定料金を使用してください。

注文

Frenet の配送業者で注文が行われると、モジュールは配送料の算出方法を保存します。管理画面の注文ページには、次の行を含む Frenet ブロックが表示されます:

Carrier:Frenet の配送業者とサービス(例:Correios または Jadlog のサービス)。リアルタイム見積もりの場合に表示されます。

Delivery time:Frenet が返した営業日単位の配送日数。リアルタイム見積もりの場合に表示されます。

Price source:Live Frenet quote、Fixed price (price per country)、Fallback cost、または Free shipping。

このデータは、Remove data on uninstall を使用してもモジュールのアンインストール後に保持されます。

ライセンスキー

このモジュールは、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox Frenet は、Modules > Module Manager > VibeFox Frenet > Configure の設定の上にある最初のブロックです。キーを License key に貼り付けて Activate をクリックしてください。その後、ブロックにはキーがマスクされた状態、ステータス(ライセンスの有効期限日やドメインなど)、そして Check now(ステータスを再確認)、Change key(別のキーを入力)、Remove key(このショップからキーを削除)のボタンが表示されます。その下には Product: presta-shipping-frenet の行と、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 のアカウントで枠を解放してください。

有効なキーがない場合、チェックアウト時に Frenet の配送業者はお客様に表示されず、料金も計算されません。PrestaShop のストアフロントは、管理画面にログインしていることを認識しないため、配送業者はあなたにも表示されません。キーを購入する前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。

ライセンスの期限が切れても、モジュールは動作を続けますが、アップデートとサポートには更新が必要です。ステータスは、管理画面で作業している間に自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日に 1 回、その後は週に 1 回です。cron ジョブは必要ありません。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。

トラブルシューティング

チェックアウトに Frenet が表示されない:ライセンスが有効であること、Enable Frenet がオンであることを確認してください。Shipping > Carriers で、配送業者がお客様の国のゾーンとお客様の顧客グループをカバーしていること、または Ignore shipping zones がオンで、その国が許可されていることを確認してください。モジュールのページ上部の警告、重量の制限、Minimum order amount を確認してください。よくある原因:お客様がまだ 8 桁の CEP を完全に入力しておらず、固定料金もない場合、または Frenet がそのルートのサービスを返さず、固定料金もない場合です。また、商品ページで特定の配送業者に制限されている場合もあります。

リアルタイム見積もりが表示されない:Debug log をオンにして、チェックアウトを再読み込みし、モジュールのページの Log 欄を確認してください。この欄には理由が表示されます。発送元の CEP がない、BRL の為替レートがない、お客様の CEP が不完全、重量または金額の制限、スキップされたサービスのメッセージ、のいずれかです。

ログに API トークンが拒否されたと表示される(HTTP 401 または 403):Frenet パネルからトークンを再度コピーし、API token に貼り付けてください。

ログに Frenet からサービスが返されなかったと表示される:Frenet パネルで少なくとも 1 つの配送業者を有効にしてください。

ショップがユーロまたはドルで販売している:Frenet は BRL で回答します。BRL exchange rate(デフォルト通貨で 1 BRL がいくらになるか)を入力してください。

Frenet の料金に税が上乗せされる:Frenet の料金は配送業者の最終料金です。Tax を No tax に設定してください。

変更後も料金が古いように見える:モジュールのページで Save をクリックしてください。キャッシュされた Frenet の見積もりが消去されます。

ページに Frenet 配送業者が見つからないと表示される:Shipping > Carriers で配送業者が削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。それまでは、保存時に The settings were saved, but the carrier could not be updated. と表示されます。

アンインストール

Modules > Module Manager に移動し、VibeFox Frenet の横にあるメニューを開いて、Uninstall を選択します。ライセンスキーとライセンスステータスは常に削除されます。キャッシュされた見積もりは常に削除されます。Remove data on uninstall がオンの場合、配送業者は削除され(注文は履歴として残ります)、設定とログも削除されます。オフの場合、配送業者は無効になるだけで、すべての設定は保持されます。モジュールを再インストールする場合や Reset を実行する場合、保存されている配送業者は以前の状態に戻ります。無効にしていた配送業者は無効のままです。既存の注文は、Frenet の配送業者と注文ページの Frenet ブロックを保持します。

Frenet は、それぞれの所有者の商標です。このモジュールは Frenet と提携しておらず、Frenet による推奨も受けていません。