VibeFox Loggi for PrestaShop — ヘルプ

要件

PrestaShop: 8.0 から 9.x。

PHP: 8.0 以降。モジュールは、それより古い PHP バージョンではインストールできません。

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

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

インストール

1. バックオフィスで Modules > Module Manager に移動し、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。

2. アップロードが完了したら Configure をクリックするか、後でモジュール一覧から VibeFox Loggi を探して Configure をクリックします。

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

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

5. Shipping > Carriers で Loggi 配送業者のゾーンにブラジルを追加するか、Ignore shipping zones を有効にして国を選択します。

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

設定

すべての設定はモジュールのページにあります：Modules > Module Manager > VibeFox Loggi > Configure。設定は配送業者のすべてのゾーンに適用されます。各セクションには独自の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Loggi の料金も消去されます。

ページ上部の警告は、設定が不完全であることを示します：API 認証情報がない（固定料金のみ使用）、API 認証情報と固定料金の両方がない（配送業者は表示されません）、集荷先住所がない、BRL 為替レートがない、またはモジュールが認識しないショップの重量または寸法の単位がある（その場合は kg または cm として計算されます。単位は International > Localization で設定してください）。値が無効な場合（たとえば負の数）、ページにエラーが表示され、何も保存されません。

一般

Enable Loggi: 配送業者を有効または無効にします。これは Shipping > Carriers の配送業者のステータスと同じスイッチです。

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

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

API e-mail: Loggi アカウントのメールアドレス。API キーはこのアカウントに属します。有効なメールアドレスである必要があります。

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

Shop ID: Loggi ダッシュボードにおけるショップの数値 ID（pk）。正の数のみ受け付けます。それ以外の値はエラーで拒否されます。

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

Pickup address: Loggi が荷物を集荷する場所を 1 行で入力します：番地と番号、地区、市、州、CEP。例：Rua Example, 123 - Bairro, São Paulo - SP, 01310-100。ショップの住所がブラジルにあり、住所と市が入力されている場合は、空のままにすると Shop Parameters > Contact > Stores のショップ住所が使われます。集荷先住所がないと 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 のリアルタイム料金はカート全体をカバーし、掛け算されることはありません。

条件

Minimum weight: カートがこの重量より軽い場合に配送業者を非表示にします（kg）。0 は制限なしを意味します。

Maximum weight: カートがこの重量より重い場合に配送業者を非表示にします（kg）。デフォルト: 30。0 は制限なしを意味します。Minimum weight は Maximum weight より大きくできません。

Minimum order amount: カートの小計（割引後、税抜き）がこの金額に達した場合にのみ配送業者を表示します。空のままにすると常に表示されます。

Free shipping from: Loggi の配送が無料になるカートの小計（割引後、税抜き）。空のままにすると送料無料はありません。

Tax: 配送業者の税ルール、または No tax。料金と Loggi の料金にすでに税が含まれている場合は No tax を選択します。

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

配送ゾーンなしでの提供

Ignore shipping zones: 一致するゾーンに関係なく、下記の国に対して Loggi を提供します。このオプションを有効にして保存すると、配送業者はすべてのゾーンに追加され、後から作成されたゾーンにも追加されます。オフにすると、追加されたゾーンが削除され、配送業者は独自のゾーンを取り戻します。

Countries: このモードの宛先の国。空のままにすると、ショップで有効なすべての国が許可されます。このフィールドは Ignore shipping zones が有効な場合のみ使用されます。

詳細設定

Debug log: 料金計算と Loggi へのリクエストを、モジュールフォルダー内の logs/vfd_lggi_debug.log.php に書き込みます。このファイルはウェブから開けません。このオプションがオフでも、API のエラーは常に記録されます。API キーと顧客の住所はログに記録されることはありません。

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

Remove data on uninstall: 有効にすると、モジュールのアンインストール時に Loggi の設定、配送業者、キャッシュされた料金、ログが削除されます。無効にすると、再インストールに備えてすべて保持されます。

チェックアウトでの動作

配送ステップで、PrestaShop はモジュールに Loggi の料金を問い合わせます。実物商品のみが対象です。仮想商品は重量を加算せず、注文金額にも含まれません。モジュールはまず条件を確認します：許可された国（Ignore shipping zones の設定による）、カートの重量、最低注文金額。送料無料が適用される場合、料金は 0 となり、Loggi へのリクエストは送信されません。

完全な 8 桁の CEP を持つブラジルの住所の場合、モジュールは Loggi の荷物を組み立てます。各商品は、最も短い辺が高さになるように回転され、荷物が 55 × 55 × 55 cm と 20 kg の範囲内に収まる限り、商品は 1 つの荷物に積み重ねられます。重量や寸法がない商品は、各辺 1 cm として計算され、各荷物は少なくとも 100 g とされます。Loggi は見積もり 1 回につき 2 個の荷物を受け付けるため、大きなカートは複数のリクエストで送信され、合計額が加算されます。モジュールは Shop ID、集荷先住所、配送先住所、荷物を Loggi に送信し、Loggi の合計額を BRL からショップのデフォルト通貨に換算します。その後、料金は購入者のカートの通貨で表示されます。

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

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

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

モジュールは料金の計算のみを行います。Loggi の注文や出荷の作成、送り状の印刷、荷物の追跡、チェックアウトでの配達日時の表示、受け取り拠点や宅配ボックスの提供は行いません。出荷は Loggi のダッシュボードで作成してください。Loggi が配送するのはブラジル国内のみです。他の国には固定料金を使用してください。

ライセンスキー

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

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

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

トラブルシューティング

チェックアウトに Loggi が表示されない: ライセンスが有効で、Enable Loggi がオンになっているか確認します。Shipping > Carriers で、配送業者が購入者の国のゾーンと顧客グループをカバーしているか確認します（または Ignore shipping zones がオンで、その国が許可されているか確認します）。モジュールのページ上部の警告、重量制限、Minimum order amount を確認します。購入者がまだ完全な CEP を入力していない場合、または Loggi が料金を返さない場合、配送業者には固定料金が必要です：国の行、* の行、または Price for countries not in the table。商品ページで、商品を特定の配送業者に限定することもできます。

固定料金のみ表示される: モジュールのページの Log フィールドを確認してください。エラーは常に記録されます。各ステップを記録するには Debug log をオンにして、チェックアウトを再読み込みしてください。よくある原因：API のメールアドレス、キー、Shop 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 の料金が消去されます。

ページに Loggi 配送業者が見つからないと表示される: Shipping > Carriers で配送業者が削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。

アンインストール

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

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