VibeFox Loggi for OpenCart — ヘルプ

動作環境

OpenCart: 3.0.x（3.0.5.0 で検証済み）または 4.0.2 以降（4.1.0.3 で検証済み）。

PHP: 8.0 以降。

Loggi アカウント（リアルタイム料金のみ）: リアルタイム料金は、Loggi がビジネスアカウント向けに発行する API キーを使って Loggi GraphQL API を利用します。Loggi のアカウントマネージャーまたは Loggi の連携サポート（integracoes@loggi.com）に依頼してください。docs.api.loggi.com の Loggi API ドキュメントも参照してください。必要な値は 3 つです: Loggi アカウントのメールアドレス、API キー、ストアの数値 ID。Loggi アカウントに新しい Loggi REST プラットフォーム API（クライアント ID とシークレット）の認証情報しかない場合、リアルタイム料金は利用できず、固定料金が使用されます。固定料金のみを使用する場合、Loggi アカウントは不要です。

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

インストール

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

OpenCart 3

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

2. Extensions > Extensions に移動し、拡張機能の種類で Shipping を選択します。VibeFox Loggi を見つけて、Install（緑の + ボタン）をクリックします。

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

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

5. Loggi API のメールアドレス、API キー、ショップ ID、集荷先住所を入力し、ストアの既定通貨が BRL でない場合は BRL 為替レートも入力します。安全策として固定料金を追加し（Configuration を参照）、Enable Loggi をオンにして Save をクリックします。

OpenCart 4

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

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

3. Extensions > Extensions に移動し、拡張機能の種類で Shipping を選択します。VibeFox Loggi を見つけて、Install（緑の + ボタン）をクリックしてから、Edit（鉛筆のボタン）をクリックします。

4. OpenCart 3 の手順 4 および 5 と同じように、ライセンスキーと設定を入力します。設定ページとそのフィールドは両方のバージョンで同じです。

インストール時に、拡張機能はキャッシュされた Loggi 料金のための小さなテーブルを作成します。Enable Loggi をオンにして保存するまで、この配送方法はオフのままです。アンインストール後に拡張機能を再インストールすると、保持されていた Loggi の設定が再び使用されます。

設定

すべての設定は拡張機能のページにあります: Extensions > Extensions > Shipping > VibeFox Loggi > Edit。セクションは左側に一覧表示されます。これらはすべてのジオゾーンに適用されます。ページ下部の Save ボタンで、ページを再読み込みせずに全体を保存します。保存のたびに、キャッシュされた Loggi 料金も消去されます。値が無効な場合（たとえば負の数値、正しくないメールアドレス、数値ではないショップ ID）、ページはエラーを表示し、何も保存されません。設定を保存できるのは、この拡張機能の変更権限を持つ管理者ユーザーだけです。

設定の上に表示される警告（保存のたびに再表示されます）は、設定が不完全であることを示します: API 認証情報がない（固定料金のみ使用）、API 認証情報も固定料金もない（配送方法は表示されない）、集荷先住所がない、または BRL 為替レートがない。ストアに単位 kg の重量クラス、または単位 cm の長さクラスがなく、既定のクラスの単位が認識されない場合は、別の警告が表示されます。その場合、商品の重量は kg、寸法は cm として扱われます。System > Localisation > Weight Classes と Length Classes でクラスを追加してください。

一般

Enable Loggi: チェックアウトで Loggi を表示または非表示にします。既定値: オフ。

Method title: カートとチェックアウトで購入者に表示される配送方法の名前。既定値: Loggi。必須、最大 64 文字で、文字 < > ; = # { } は使用できません。

Sort order: チェックアウトの配送方法の中での、Loggi の表示位置。整数です。

Loggi API（リアルタイム料金）（固定料金のみを使用する場合は認証情報を空欄のままにしてください）

API e-mail: Loggi アカウントのメールアドレス。API キーはこのアカウントに属します。有効なメールアドレスである必要があります。消去すると、保存された API キーも消去されます。

API key: Loggi の API キー。Loggi にのみ送信され、ログに記録されることはありません。保存後、この欄は空のままになり、Saved — leave empty to keep it; clear the API e-mail to remove it. と表示されます。変更する場合にのみ新しい値を入力してください。API e-mail を変更する場合は、新しいメールアドレスの API キーも入力してください。入力しないと、ページはエラーを表示し、何も保存されません。

Shop ID: Loggi のダッシュボードにあるストアの数値 ID（pk）（例: 12345）。それ以外の値はエラーで拒否されます。

Staging: テスト用の認証情報で Loggi のステージング環境を使用します。ステージング環境と本番環境では、アカウントとキーが異なります。既定値: オフ。

Pickup address: Loggi が荷物を集荷する場所を 1 行で入力します: 番地、地区、市、州、CEP（例: Rua Example, 123 - Bairro, São Paulo - SP, 01310-100）。リアルタイム料金には必須です。OpenCart のストア住所は自由入力のため、代わりに使われることはありません。集荷先住所がない場合、Loggi は見積もりを出せず、固定料金のみが使用されます。

BRL exchange rate: Loggi の料金はブラジル・レアルです。ストアの既定通貨が BRL の場合、この欄は不要であり、ページにその旨が表示されます。そうでない場合は、1 BRL がストアの通貨でいくらになるかを入力します（例: 0.16）。これがないとリアルタイム料金は使用されません。正の数値のみ受け付けます。小数点区切りとしては、ピリオドとカンマの両方が使えます。

固定料金（ストアの既定通貨、税抜き）

固定料金は、Loggi API が設定されていない場合、ブラジル以外の宛先、または CEP が完全でない場合に使用され、Loggi が料金を返さない場合（API が停止している、キーが拒否された、住所が対象地域外など）にも使用されます。

Price table: 宛先の国ごとに 1 行です。Add country をクリックすると行が追加され、削除ボタンで行を削除できます。個別の行がないすべての国には * All other countries を選択します。各行には Base price と重量列があります。XS は 1 kg まで、S は 2 kg まで、M は 3 kg まで、L は 5 kg まで、XL は 5 kg を超える場合です。空欄（または 0）の重量列は基本料金を使用します。基本料金が 0 の場合は送料無料です。"9.99" と "9,99" のどちらも受け付けられます。空の行と同じ国の 2 行目は、保存時に削除されます。

Price for countries not in the table: Loggi のリアルタイム料金がなく、料金表に宛先の国の行がない場合（* 行もない場合）に使用されます。その場合に配送方法を非表示にするには空欄にします。

Fixed price applies: 固定料金の計算方法。Loggi のリアルタイム料金はカート全体を対象としており、掛け算されることはありません。

Per order (one parcel, tier by total cart weight): カートに対して 1 つの料金。重量列はカートの合計重量によって選ばれます。これが既定値です。

Per item (every item is a separate parcel, tier by its own weight): 各商品をそれぞれの重量で料金計算し、料金を合計します。

条件

Minimum weight (kg): カートの重量がこれ未満の場合は配送方法を非表示にします。0 は制限なし（既定値）を意味します。

Maximum weight (kg): カートの重量がこれを超える場合は配送方法を非表示にします。既定値: 30。0 は制限なしを意味します。Minimum weight は Maximum weight より大きくすることはできません。

Minimum order amount: 配送が必要な商品の小計（クーポン適用後、税抜き）がこの金額に達した場合のみ、配送方法を表示します。常に表示する場合は空欄にします。

Free shipping from: Loggi の配送が無料になる、配送が必要な商品の小計（クーポン適用後、税抜き）。送料無料がない場合は空欄にします。

Tax class: 送料の税クラス、または No tax（既定値）。料金と Loggi の料金にすでに税金が含まれている場合は No tax を選択してください。

Geo zone: この地理的ゾーン内の住所に対してのみ Loggi を提供します。All zones（既定値）は制限なしを意味します。ジオゾーンは System > Localisation > Geo Zones で管理されます。Ignore shipping zones がオンの場合、ジオゾーンは確認されません。

重量の制限と重量列については、重量のない商品は 0 kg として扱われます。

国

OpenCart には配送業者ゾーンがありません。Geo zone は、配送方法を 1 つのジオゾーンの住所に限定します。代わりに Ignore shipping zones をオンにして、国のリストを選ぶこともできます。

Ignore shipping zones: Geo zone に関係なく、下記の国に対して Loggi を提供します。このモードではジオゾーンは確認されません。既定値: オフ。

Countries: このモードの配送先の国です。空欄にするとストアで有効になっているすべての国を許可します。この欄は Ignore shipping zones がオンの場合にのみ使用されます。

詳細設定

Debug log: 料金計算と Loggi へのリクエストを storage/logs/vfd_lggi_debug.log.php（OpenCart 4 では system/storage/logs/vfd_lggi_debug.log.php）に書き込みます。このファイルは Web から読み取ることはできません。この設定がオフでも、API エラーは常に記録されます。API キーと顧客の住所はログに記録されません。ファイルが 5 MB に達すると、vfd_lggi_debug.old.log.php に移動され、新しいログが開始されます。

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

Remove data on uninstall: オンの場合、拡張機能をアンインストールすると、Loggi の設定とログが削除されます。オフ（既定値）の場合は、再インストールに備えて設定が保持されます。キャッシュされた料金は常に削除されます。

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

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

Import: 以前にエクスポートした JSON を貼り付け、Import をクリックすると、設定を復元します（例: 別のストアで）。値は通常の保存と同じように検証されます。保存済みの API キーは保持されます。

チェックアウトでの動作

OpenCart が配送方法を表示するとき、拡張機能に Loggi の料金を問い合わせます。Geo zone が設定されていて、Ignore shipping zones がオフであり、住所がそのジオゾーンの外にある場合、Loggi は提供されません。Requires Shipping が Yes に設定された商品のみが対象になります。それ以外の商品は重量に加算されず、注文金額にも含まれません。次に拡張機能は条件を確認します。許可された国（Ignore shipping zones 使用時）、カートの重量、最小注文金額です。注文金額は、配送が必要な商品の価格で、クーポン割引後、税抜きの金額です。ギフト券、ポイント、ストアクレジットは考慮されません。送料無料が適用される場合、料金は 0 となり、Loggi へのリクエストは送信されません。

郵便番号（CEP）が 8 桁すべて入力されたブラジルの住所の場合、拡張機能は Loggi のパッケージを組み立てます。各商品は、最も短い辺が高さになるように回転され、パッケージが 55 × 55 × 55 cm、20 kg の範囲内に収まる限り、商品は 1 つのパッケージに積み重ねられます。重量や寸法のない商品は各辺 1 cm として扱われ、各パッケージは最低 100 g とされます。Loggi は 1 回の見積もりで 2 パッケージまでを受け付けるため、より大きなカートは複数のリクエストで送信され、合計額が加算されます。拡張機能は、ショップ ID、集荷先住所、配送先住所（番地、市、州、CEP）、パッケージを Loggi に送信し、Loggi の合計額を BRL からストアの既定通貨に換算します。料金はその通貨の小数桁に丸められ、選択した Tax class の税を含めて、購入者の通貨で表示されます。

Loggi の各料金は、カート、住所、アカウント、環境ごとに 1 時間キャッシュされるため、同じカートでは新たなリクエストは発生しません。失敗した見積もりは 10 分間キャッシュされます。Loggi にまったく接続できない場合、リクエストは 2 分間一時停止されるため、チェックアウトの更新のたびに Loggi を待つことはありません。API のタイムアウトは 10 秒です。

API が設定されていない場合、住所がブラジル外であるか CEP が完全でない場合、BRL 為替レートがない場合、集荷先住所がない場合、商品が Loggi のパッケージより大きい場合、カートに 10 個を超えるパッケージが必要な場合、または Loggi がエラー、拒否されたパッケージ、対象外の住所、もしくは合計ゼロを返した場合には、固定料金が使用されます。固定料金もない場合、配送方法は非表示になります。購入者に API エラーが表示されることはありません。理由は debug ログに記録されます。

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

この拡張機能が計算するのは料金のみです。Loggi の注文や出荷の作成、ラベルの印刷、荷物の追跡、チェックアウトでの配送時間の表示、集荷拠点やロッカーの提供は行いません。注文に何かを追加することもありません。注文には、他の OpenCart の配送方法と同様に、配送方法のタイトルと送料が表示されます。出荷は Loggi ダッシュボードで作成してください。Loggi はブラジル国内のみに配送します。その他の国では固定料金を使用してください。

ライセンスキー

この拡張機能は、vibefox.net で入手した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox Loggi は、Extensions > Extensions > Shipping > VibeFox Loggi > Edit の一番上、設定の上にあるブロックです。キーを License key に入力して Activate をクリックしてください。その後、ブロックにはマスクされたキー、ステータス（たとえばライセンスの有効期限日とドメイン）、そして Check now（ステータスを再確認）、Change key（別のキーを入力）、Remove key（このストアからキーを削除）のボタンが表示されます。その下には Product: opencart-shipping-loggi の行と、Manage licenses and domains in your account のリンク（vibefox.net のアカウントが開きます）があります。キーを変更できるのは、この拡張機能の Modify 権限を持つ管理者ユーザーだけです。ブロックの文言は管理画面の言語に従います（英語とロシア語を含みます）。

キーが受け付けられない場合、ブロックには理由が表示されます。たとえば Key not found、This key belongs to another product、Domain limit reached、または日付付きの License expired on です。ストアのアドレスを変更した後、またはアカウントでドメインの枠を解放した後に、Check now をクリックしてください。ライセンスサーバーに接続できない場合、拡張機能は最後に確認できた状態のまま動作を続けます。

1 つのキーは 1 つのドメインで使用できます。ストア（OpenCart の設定にあるストアアドレス）ごとです。ストアからキーを削除しても、そのドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

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

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

トラブルシューティング

チェックアウトに Loggi が表示されない: ライセンスが有効であること、Enable Loggi がオンであることを確認してください。Geo zone、Ignore shipping zones、Countries を確認してください。拡張機能ページ上部の警告、重量の制限、Minimum order amount も確認してください。購入者がまだ完全な CEP を入力していない場合、または Loggi が料金を返さない場合、この配送方法には固定料金が必要です: その国の行、* 行、または Price for countries not in the table。商品の Requires Shipping が Yes に設定されているか確認してください。

固定料金のみが表示される: 拡張機能ページの Log 欄を確認してください。エラーは常に記録されます。各ステップの Debug log をオンにして、チェックアウトを再読み込みしてください。よくある原因: API のメールアドレス、キー、またはショップ ID が不足している、集荷先住所がない、BRL 以外のストア通貨で BRL exchange rate がない、まだ 8 桁の完全な CEP がない、商品が 55 cm を超えるか 20 kg を超える、または住所が Loggi の対象地域外である。

ログに HTTP 401 または 403 が出る: Loggi が API のメールアドレスまたはキーを拒否しました。Loggi で確認し、Staging が認証情報と一致しているか確認してください。ステージングと本番のキーは異なります。

ストアがユーロまたはドルで販売している: Loggi は BRL で応答します。BRL exchange rate（1 BRL がストアの既定通貨でいくらになるか）を入力してください。固定料金は常にストアの既定通貨です。

料金が正確でない: 商品の重量と寸法を入力してください。入力がない場合、商品は各辺 1 cm、各パッケージは最低 100 g として扱われます。

Per item が Loggi の料金を掛け算しない: これは仕様どおりです。Loggi のリアルタイム料金はカート全体を対象とします。Per item は固定料金にのみ適用されます。

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

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

開発者向け: Loggi API のアドレスは、設定 vfd_lggi_api_url（テスト用）で置き換えることができます。設定ページにはこの項目のフィールドはありません。

アンインストール

Extensions > Extensions に移動し、種類 Shipping を選んで、VibeFox Loggi の横にある Uninstall（赤い − ボタン）をクリックします。この拡張機能のライセンスキーとライセンス状態は、常に削除されます。OpenCart は常に Enable Loggi、Sort order、Tax class、Geo zone をリセットします。キャッシュされた Loggi の料金（その表を含む）は常に削除されます。Remove data on uninstall がオンの場合は、Loggi の設定とデバッグログも削除されます。オフの場合は、その他の設定が保持され、拡張機能を再インストールしたときに再び使用されます。既存の注文は、配送方法と送料をそのまま保持します。

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

Loggi は、それぞれの所有者の商標です。この拡張機能は Loggi と提携しておらず、Loggi による承認もされていません。