戻る

VibeFox Frenet for OpenCart — ヘルプ

動作要件

OpenCart:3.0.x(3.0.5.0 で動作確認済み)または 4.0.2 以降(4.1.0.3 で動作確認済み)。

PHP:8.0 以降。

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

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

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

インストール

ダウンロードは、両方の OpenCart バージョン用のパッケージを含む 1 つの zip ファイルです。コンピューターで解凍してください。ファイルには README.txt、OpenCart 3 用のパッケージ vfd_frenet-oc3-(version).ocmod.zip、OpenCart 4 用のパッケージ vfd_frenet.ocmod.zip が含まれています。ご使用の OpenCart のバージョンに対応するパッケージのみをインストールしてください。ライセンスキーは両方のバージョンで同じです。

OpenCart 3

1. 管理画面で Extensions > Installer に進み、Upload をクリックして、ファイル vfd_frenet-oc3-(version).ocmod.zip を選択します。この拡張機能は OCMOD の変更を追加しないため、Extensions > Modifications を更新する必要はありません。インストーラーを使う代わりに、このパッケージの upload フォルダ内の内容をストアのルートフォルダにコピーすることもできます。

2. Extensions > Extensions に進み、拡張機能の種類で Shipping を選択します。VibeFox Frenet を見つけて、Install(緑色の + ボタン)をクリックします。

3. Edit(鉛筆のボタン)をクリックして設定ページを開きます。

4. Edit ページの上部にあるライセンスブロックの License key 欄に VibeFox ライセンスキーを入力し、Activate をクリックします(ライセンスキーを参照)。

5. API トークンを貼り付け、発送元の CEP を入力します。ストアの基本通貨が BRL でない場合は、BRL の為替レートを入力します。必要に応じて固定価格と予備の料金を追加します。Enable Frenet をオンにして、Save をクリックします。

OpenCart 4

1. 管理画面で Extensions > Installer に進み、Upload をクリックして、ファイル vfd_frenet.ocmod.zip を選択します。ファイル名は変更しないでください。OpenCart 4 は拡張機能のコードをファイル名から読み取るため、名前を変更したパッケージは動作しません。

2. 同じページのインストール済み拡張機能の一覧にパッケージが表示されます。その横の Install(緑色の + ボタン)をクリックします。

3. Extensions > Extensions に進み、拡張機能の種類で Shipping を選択します。VibeFox Frenet を見つけて、Install(緑色の + ボタン)をクリックし、次に Edit(鉛筆のボタン)をクリックします。

4. OpenCart 3 の手順 4 と 5 と同様に、ライセンスキーと設定を入力します。設定ページとその項目は、両方のバージョンで同じです。

インストール後は、Enable Frenet をオンにして保存するまで、この配送方法はオフのままです。アンインストール後に再インストールした場合は、保存されていた Frenet の設定が再び使用されます。

設定

すべての設定は拡張機能のページにあります:Extensions > Extensions > Shipping > VibeFox Frenet > Edit。セクションは左側に一覧表示されます。ページ下部の Save ボタン 1 つで、ページを再読み込みせずにページ全体を保存します。保存のたびに、キャッシュされた Frenet の見積もりも消去されます。価格の入力欄は、小数点区切りとしてピリオドとカンマのどちらも受け付けます。値が正しくない場合は何も保存されず、理由がページに表示されます。例:Enter a valid method title (64 characters max, without < > ; = # { }).、"…" must be a number.、"…" must not be negative.。BRL exchange rate が 0 以下の場合や、Minimum weight (kg) が Maximum weight (kg) より大きい場合も拒否されます。この拡張機能の変更権限を持つ管理者ユーザーのみが設定を保存できます。

ページの上部には、保存のたびに警告が表示されます。API トークンがない(固定価格のみ使用される。固定価格もなければ配送方法は表示されない)、発送元の CEP がない、発送元の CEP が 8 桁でない、基本通貨が BRL で為替レートがない、といった場合です。また、ストアに単位が kg の重量クラス、または単位が cm の長さクラスがない場合にも警告されます。その場合、商品の重量と寸法は、そのクラスの単位名に従って換算され、不明な単位は kg または cm として扱われます。System > Localisation > Weight Classes と Length Classes を確認してください。

全般

設定はすべての地域ゾーンに適用されます。Conditions で配送方法を特定の地域ゾーンに限定することも、Ignore shipping zones を使うこともできます。価格は常にこの拡張機能から取得されます。

Enable Frenet:チェックアウトで Frenet を表示するかどうかを設定します。初期値:オフ。

Method title:カートとチェックアウトでお客様に表示される配送方法の名前です。初期値:Frenet。必須で、最大 64 文字。次の文字は使用できません:< > ; = # { }。

Sort order:チェックアウトの配送方法の中で Frenet が表示される位置です。整数で指定します。

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

Frenet は、Frenet アカウントで有効にした配送業者(Correios、Jadlog、Loggi など)を比較し、カートに対する価格を返します。リアルタイム見積もりは、ブラジルの 8 桁の完全な CEP を持つ住所に対してのみ要求されます。このセクションには Frenet パネルへのリンクがあります。

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

Origin CEP:荷物を発送する場所の郵便番号(CEP)です。例:01001-000。OpenCart にはストアの郵便番号がないため、リアルタイム見積もりにはこの欄が必要です。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 の場合、この欄には Frenet の価格をそのまま使用することが表示されます。

固定価格

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 (all other countries) を使用します。価格が 1 つもない行は、保存時に削除されます。

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 (kg) より小さくすることはできません。

Minimum order amount:配送が必要な商品の小計(クーポン適用後、税抜き)が、この金額以上の場合にのみ配送方法を表示します。空欄にすると常に表示されます。

Free shipping from:送料が無料になる小計(クーポン適用後、税抜き)です。空欄にすると、送料無料にはなりません。

Tax class:送料に加算する税クラス、または No tax です。Frenet の価格は配送業者の最終価格です。OpenCart でこの価格に税金を加えたくない場合は、No tax を選択してください。

Geo zone:この地域ゾーン内の住所に対してのみ Frenet を提供します。All zones は制限なしを意味します。Ignore shipping zones と一緒には使用されません。地域ゾーンは System > Localisation > Geo Zones で管理します。

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

通常、配送方法は Conditions で選択された地域ゾーンで提供されます(どれも選択されていない場合はすべてのゾーンで提供されます)。

Ignore shipping zones:一致する地域ゾーンに関係なく、以下の国に対して Frenet を提供します。この場合、Conditions の Geo zone は確認されません。

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

詳細設定

Debug log:すべての見積もりのリクエストとレスポンスを storage/logs/vfd_frn_debug.log.php(OpenCart 4 では system/storage/logs/vfd_frn_debug.log.php)に記録します。このファイルはウェブから読み取ることはできません。API のエラーは常に記録されます。トークンは記録されず、お客様の CEP は短縮されます。作業が終わったらオフにしてください。ファイルが 5 MB に達すると、vfd_frn_debug.old.log.php に移動され、新しいログが開始されます。

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

Remove data on uninstall:オンにすると、拡張機能をアンインストールした際に、すべての Frenet 設定とログが削除されます。オフの場合は、再インストール用にすべてが保持されます。キャッシュされた見積もりは常に削除されます。注文と一緒に保存された Frenet のサービスは注文履歴の一部であるため、保持されます。

インポート / エクスポート

Export:Download JSON をクリックすると、設定を JSON ファイルとして保存できます。API トークンはエクスポートされません。

Import:以前にエクスポートした JSON を貼り付け、Import をクリックすると、設定を復元できます。例えば別のストアに復元する場合に使用します。値は通常の保存と同じようにチェックされます。保存済みの API トークンは保持されます。

チェックアウト時の動作

OpenCart が配送方法を表示するとき、拡張機能に Frenet の価格を問い合わせます。Geo zone が設定されていて(かつ Ignore shipping zones がオフの)、住所がその範囲外の場合、Frenet は提供されません。Requires Shipping が Yes に設定されている商品のみが計算対象になります。それ以外の商品は重量に加算されず、注文金額にも含まれません。その後、拡張機能は国のリスト(Ignore shipping zones がオンの場合)、カートの重量、最低注文金額を確認します。注文金額は、クーポン割引後、税抜きの配送対象商品の価格です。送料無料が適用される場合、価格は 0 になり、Frenet へのリクエストは送信されません。

ブラジルの 8 桁の完全な CEP を持つ住所で、API トークンと発送元の CEP が設定されている場合、拡張機能は Frenet に発送元と配送先の CEP、カートのすべての商品(kg 単位の重量、cm 単位の寸法、数量、商品の Model とそのカテゴリー)、BRL 単位の注文金額、およびカートのクーポンコードを送信します。CEP が未入力の間はリクエストを行いません。Frenet は、有効にした配送業者のサービスを返します。エラーがあるサービスや価格がないサービスはスキップされます。拡張機能は最安または最速のサービスを選び、価格を基本通貨に換算します。価格は基本通貨の小数点以下の桁数に丸められ、選択した Tax class の税額を含めて、お客様の通貨で表示されます。

各レスポンスは、同じカートと同じ住所に対して 1 時間キャッシュされます。失敗したリクエストや、有効な配送業者が対応していない CEP は、10 分間記憶されます。API のタイムアウトは 10 秒です。これらの場合、お客様にエラーは表示されません。固定価格または予備の料金が使用されるか、どちらもなければ配送方法が非表示になります。理由はログに記録されます。ブラジル以外の住所では、固定価格のみが使用されます。

OpenCart 4 では、お客様はチェックアウトページの配送方法のブロックで Choose をクリックし、ウィンドウ Shipping method options で Frenet を選択します。この方法は OpenCart 3 と同じように動作します。

拡張機能は料金の計算のみを行います。配送伝票の作成、ラベルの印刷、荷物の追跡は行いません。カートごとに表示されるのは Frenet のサービス 1 つだけで、複数ではありません。受け取り場所やロッカーにも対応していません。Frenet の見積もりはブラジル国内に限られるため、他の国では固定価格を使用してください。

注文

Frenet を使って注文が行われると、拡張機能は配送料の計算方法を保存します。これはお客様が配送ステップで見た選択肢と全く同じものであり、Frenet への新しいリクエストは行われません。Sales > Orders の注文ページには、次の行を含む Frenet ブロックが表示されます:

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

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

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

OpenCart 4 では、ブロックは History の上に表示されます。お客様が注文を再度確定すると、OpenCart 4 は同じ注文を更新します。その際、保存された Frenet のデータも更新されます。お客様が別の配送方法を選択していた場合、その注文の Frenet のデータは削除されます。

このブロックは、拡張機能が無効になっている場合にも表示されます。このデータは、Remove data on uninstall がオンであっても、拡張機能をアンインストールしたときに保持されます。

ライセンスキー

この拡張機能は、vibefox.net で取得した VibeFox ライセンスキーを使って動作します。License — VibeFox Frenet のライセンスブロックは、Extensions > Extensions > Shipping > VibeFox Frenet > Edit ページの一番上、設定の上にあります。キーを License key 欄に貼り付けて、Activate をクリックします。その後、ブロックにはキーがマスク表示され、ステータス(例:ライセンスの有効期限日とドメイン)と、ステータスを再確認する Check now、別のキーを入力する Change key、このストアからキーを削除する Remove key のボタンが表示されます。その下には Product: opencart-shipping-frenet の行と、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 のアカウントで枠を解放してください。

有効なキーがない場合、Frenet の配送方法はチェックアウトでお客様に表示されず、料金も計算されません。同じブラウザで管理画面にログインしている管理者ユーザーは、ストアで引き続き配送方法を表示でき、(unlicensed — visible to admins only) と表示されます。そのため、キーを購入する前に拡張機能の設定とテストを行えます。OpenCart 4 ではこのプレビューは利用できません。ストアは管理画面のログイン状態を認識しないため、有効なキーがない場合は、誰に対しても配送方法が非表示になります。Edit ページを一度開くと、管理画面の Dashboard にリマインダーが表示されます。× で閉じると、7 日間非表示になります。既存の注文には影響しません。

ライセンスの期限が切れても拡張機能は動作を続けますが、アップデートとサポートには更新が必要です。管理画面の Dashboard または Edit ページを開くと、ステータスは自動的に再確認されます。キーを入力してから最初の 14 日間は 1 日 1 回、その後は週に 1 回です。cron ジョブは不要です。拡張機能をアンインストールすると、ライセンスキーとライセンスの状態は常に削除されます。

トラブルシューティング

Frenet がチェックアウトに表示されない:ライセンスが有効であること、Enable Frenet がオンであることを確認してください。Geo zone、または Ignore shipping zones と Countries、重量制限、Minimum order amount を確認してください。拡張機能ページの上部にある警告を確認してください。よくある原因:お客様がまだ 8 桁の完全な CEP を入力しておらず、固定価格もない。または、Frenet がそのルートのサービスを返さず、固定価格もない。商品の Requires Shipping が Yes に設定されていることも確認してください。

リアルタイム見積もりが表示されない: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 class を No tax に設定してください。

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

ページに "Warning: You do not have permission to modify VibeFox Frenet!" と表示される:管理者のユーザーグループは設定を閲覧のみできる可能性があります。System > Users > User Groups で、そのグループに extension/shipping/vfd_frenet(OpenCart 3)または extension/vfd_frenet/shipping/vfd_frenet(OpenCart 4)の変更権限を付与してください。

開発者向け:Frenet の見積もりのアドレスは、設定 vfd_frn_api_url(テスト用)で置き換えることができます。この設定には設定ページに入力欄はありません。

アンインストール

Extensions > Extensions に進み、種類 Shipping を選択して、VibeFox Frenet の横にある Uninstall(赤い − ボタン)をクリックします。この拡張機能のライセンスキーとライセンスの状態は、常に削除されます。OpenCart は常に Enable Frenet、Sort order、Tax class、Geo zone をリセットします。キャッシュされた見積もりは常に削除されます。この拡張機能の OpenCart イベントも削除されます(OpenCart 4 では、新しい注文の Frenet データを保存するイベントも削除されます)。そのため、注文ページに Frenet のブロックは表示されなくなります。注文と一緒に保存された Frenet のデータは保持され、再インストール後に再び表示されます。Remove data on uninstall がオンの場合、Frenet の設定とデバッグログも削除されます。オフの場合、その他の設定は保持され、拡張機能を再インストールしたときに再び使用されます。既存の注文は、配送方法と送料を保持します。

OpenCart 4 で拡張機能のファイルも削除するには、アンインストール後に Extensions > Installer に進み、インストール済みの拡張機能の一覧にある VibeFox Frenet の横の Uninstall(オレンジ色の − ボタン)をクリックしてから、アップロードしたパッケージを削除するために Delete(赤いゴミ箱のボタン)をクリックしてください。

Frenet は、それぞれの所有者の商標です。本拡張機能は Frenet と提携しておらず、Frenet の承認や支持も受けていません。