戻る

VibeFox GIG Logistics for PrestaShop — ヘルプ

要件

PrestaShop: 8.0 から 9.x。

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

GIG Logistics API の認証情報(リアルタイム料金の場合のみ): リアルタイム料金は、GIG Logistics のサードパーティ API を使用します。GIG Logistics は法人のお客様に、API ユーザー名(通常はメールアドレス)とパスワードを発行します。GIG Logistics の開発者ページ(giglogistics.com/developer)でご依頼ください。テスト用の認証情報はテスト API でのみ使用できます。料金表とフォールバック料金のみを使用する場合、API の認証情報は不要です。

ショップでのナイジェリア: リアルタイム料金はナイジェリアの配送先住所についてのみ問い合わせるため、国「Nigeria」が International > Locations > Countries に存在し、有効になっている必要があります。

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

インストール

1. 管理画面で Modules > Module Manager を開き、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。

2. アップロードが完了したら Configure をクリックします。後で行う場合は、モジュール一覧から VibeFox GIG Logistics を探し、Configure をクリックします。

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

4. 料金表やフォールバック料金を入力します。リアルタイム料金を使う場合は、API のユーザー名とパスワード、集荷先の電話番号、市区町村、州も入力します。デフォルト通貨が NGN でない場合は、通貨換算レートも入力します(設定を参照)。Save をクリックします。

5. Nigerian states の項目に Add Nigerian states ボタンが表示されている場合は、そのボタンをクリックします(設定を参照)。

インストール時に、モジュールは配送時間の文言 Courier delivery を設定した GIG Logistics 配送業者を作成します。配送業者はナイジェリアのゾーン(デフォルトのショップではアフリカ)と、すべての顧客グループに紐付けられます。ゾーン、顧客グループ、配送時間、ロゴ、サイズ制限は Shipping > Carriers で変更できます。料金はそこで設定しないでください。料金は常にモジュールから取得されます。

設定

すべての設定はモジュールのページにあります: Modules > Module Manager > VibeFox GIG Logistics > Configure。各セクションには独自の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた GIG Logistics の料金、API トークン、住所の座標もクリアされます。

セクションの上部には、リアルタイム料金を使用できない場合に警告が表示されます。API のユーザー名かパスワードのどちらか一方しか入力されていない場合、Sender phone または集荷先の市区町村や州が未入力の場合、デフォルト通貨が NGN でなく Currency conversion rate が設定されていない場合です。GIG Logistics の配送業者が見つからない場合や、ショップの重量単位(International > Localization > Local units)がモジュールで認識されない場合も警告されます。後者の場合、商品の重量は kg として扱われます。保存時には、不正な数値(負の金額、0 の Currency conversion rate、-90 から 90 の範囲外の緯度、-180 から 180 の範囲外の経度)、Max weight (kg) を上回る Min weight (kg)、空または無効な Method title、または不明な税ルールがあるとエラーが報告され、何も保存されません。

General

このページの設定は、配送業者のすべてのゾーンに適用されます。

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

Method title: カートとチェックアウトに表示される配送業者の名前。デフォルト: GIG Logistics。必須です。

Tax: 配送業者の税ルール、または No tax。税ルールを選ぶと、配送料に配送料の税が加算されます。GIG の料金にすでに請求したい内容がすべて含まれている場合は、No tax を選択してください。

GIG Logistics API (live prices)(任意)

API の認証情報があれば、ナイジェリアの住所ごとに料金が GIG Logistics に問い合わせられます。認証情報がない場合、または API が料金を返さない場合は、料金表とフォールバック料金が使用されます。

API username: GIG Logistics のサードパーティ API のユーザー名。通常はメールアドレスです。

API password: GIG Logistics のサードパーティ API のパスワード。API へのログインにのみ使用され、ログに記録されることはありません。保存後、この項目は空のままになり、Saved — leave empty to keep it. と表示されます。変更する場合のみ新しい値を入力してください。パスワードを削除するには、API username を空にして保存します。

Test mode: GIG Logistics のテスト(dev)API を使用します。テスト用の認証情報はテスト API でのみ使用できます。実際の料金を取得するにはオフにしてください。デフォルト: オフ。

Currency conversion rate: GIG Logistics は料金を NGN で返します。ショップのデフォルト通貨が NGN でない場合は、1 NGN がデフォルト通貨でいくらに相当するかを入力します(例: 1 NGN = ? のデフォルト通貨、0.0006)。レートは 0 より大きい値である必要があります。設定がない場合、GIG のリアルタイム料金は使用されません。デフォルト通貨が NGN の場合は、その旨が項目に表示され、入力は不要です。小数点の区切り記号として、ピリオドとカンマのどちらも使用できます。

Pickup (sender) address

GIG Logistics がナイジェリアで荷物を集荷する場所です。ショップがナイジェリアにある場合、空欄の番地、市区町村、州には Shop Parameters > Contact > Stores のショップ住所が使用されます。

Sender name: GIG Logistics に送信される差出人名。空欄の場合はショップ名が使用されます。

Sender phone: お客様の電話番号(例: 08030000000)。リアルタイム料金には GIG Logistics が必要とします。

Street address: 集荷先の番地。

City / area: 集荷先の市区町村またはエリア(例: Victoria Island)。リアルタイム料金には必須です。

State: 集荷先住所のナイジェリアの州で、37 州から選択します。デフォルトの選択肢 Shop state (Shop parameters > Contact > Stores) は、ショップ住所の州を使用します。リアルタイム料金には必須です。

Pickup latitude: 集荷地点の地図上の緯度(任意。例: 6.4281)。GIG Logistics は距離に応じて料金を計算します。空欄の場合、住所から座標が検索されます。

Pickup longitude: 集荷地点の地図上の経度(任意。例: 3.4219)。

Address lookup: OpenStreetMap(Nominatim)で住所の地図上の座標を検索します。GIG Logistics は集荷先と配送先の座標から料金を計算します。購入者の番地、市区町村、州は nominatim.openstreetmap.org に送信され、結果は 30 日間キャッシュされます。この機能をオフにすると住所のテキストのみが送信され、GIG Logistics が料金を返さない場合があります。デフォルト: オン。

Nigerian states: 配送先住所の州は、GIG Logistics と住所検索に送信されます。PrestaShop にはデフォルトでナイジェリアの州がありません。州がない場合は、番地と市区町村のみが使用されます。Add Nigerian states ボタンは 37 州(LA、FC などのコード)を追加し、ナイジェリアで Contains states をオンにして、ナイジェリアの住所フォームに州の項目を追加します。すでに存在する州(コードまたは名前で判定)は、重複して追加されません。すべての準備が整うと、ナイジェリアの住所に対して州が何件あるかが項目に表示されます。ボタンをクリックするまで、何も変更されません。

Price table and fallback

リアルタイム料金が設定されていない場合、または GIG Logistics が料金を返さない場合に、他の国に使用されます。料金はショップのデフォルト通貨で、税抜きです。

Country prices: 国ごとの基本料金を設定する表です。Add country をクリックすると行が追加され、ごみ箱アイコンをクリックすると削除されます。独自の行がないすべての国には、* Any other country を選択します。XS(1 kg まで)、S(2 kg まで)、M(3 kg まで)、L(5 kg まで)、XL(5 kg 超)の列は、任意の重量区分の料金です。0 より大きい区分料金は、その区分のカートについて基本料金に代わって使用されます。料金 0 は送料無料を意味します。空欄の料金セルは 0 として保存されるため、追加した各行には基本料金を入力してください。同じ国が 2 回現れた場合は、後の行が保持されます。保存後、修正された値は警告に一覧表示されます。行がない国(* の行がない場合)には、料金表からの料金は適用されません。

Fallback cost: GIG Logistics も料金表も料金を提供しない場合に使用されます。空欄の場合は、その場合に配送業者が非表示になります。

Table / fallback price is: Per order は料金を 1 回だけ請求します。Per item (multiplied by the number of items) は、カート内の商品数を掛けて料金を計算します。GIG のリアルタイム料金は、常に注文全体に対するものです。

Conditions

Free shipping from: この金額以上で送料が無料になる、カートの小計(配送が必要な商品、割引後、税抜き)。空欄の場合、送料が無料になることはありません。

Minimum subtotal: カートの小計がこの金額に達した場合にのみ、配送業者を表示します。空欄の場合は常に表示されます。

Min weight (kg): カートの最小重量(kg)。商品の重量は、ショップの重量単位から換算されます。0 は制限なしを意味します。

Max weight (kg): カートの最大重量(kg)。デフォルト: 30。0 は制限なしを意味します。

Availability without shipping zones

Ignore shipping zones: 配送業者のゾーンに含まれていなくても、以下の国に対して配送業者を提供します。オンにすると、配送業者はすべての有効なゾーンに紐付けられ、後で作成されたゾーンにも紐付けられます。オフにすると、配送業者は以前のゾーンを取り戻します。

Countries: このモードの配送先の国。空欄の場合は、発送可能なすべての国が対象になります。Ignore shipping zones を使用する場合にのみ使用されます。

Advanced

Debug log: 料金の計算内容を、モジュールフォルダー内の logs/vfd_gigl_debug.log.php に書き込みます。このファイルは Web から開くことはできません。API のエラーは、ログがオフでも常に記録されます。パスワード、トークン、お客様の住所は書き込まれません。

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

Remove data on uninstall: オンにすると、モジュールのアンインストール時に、モジュールの設定、配送業者、キャッシュ、ログが削除されます。オフの場合、再インストールに備えてすべてが保持されます。注文は常に保持されます。

チェックアウト時の動作

配送のステップで、PrestaShop はモジュールに GIG Logistics の料金を問い合わせます。配送が必要な商品のみが計算に含まれます。バーチャル商品は重量に加算されず、小計にも含まれません。モジュールはまず条件を確認します。配送先の国(Ignore shipping zones の設定を含む)、カートの重量、最低小計です。小計が Free shipping from に達している場合、料金は 0 となり、GIG Logistics へのリクエストは送信されません。

次に、料金は料金を返す最初のソースから取得されます。まず、GIG Logistics のリアルタイム料金です。これは、API の認証情報が入力され、住所がナイジェリアにあり、住所に市区町村または州があり、集荷先の電話番号、市区町村、州が設定され、デフォルト通貨が NGN でないショップについては換算レートが設定されている場合に使用されます。モジュールは GIG Logistics の API にログインし、集荷先と配送先の住所と座標、および名前、数量、重量、価値を含むカートの商品を送信します。重量のない商品は 1 kg として送信されます。料金は自転車配送で問い合わせられます。次に、Country prices の料金表です。3 番目は Fallback cost です。いずれも料金を返さない場合、そのカートでは配送業者が非表示になります。料金はデフォルト通貨で計算され、その後、購入者のカートの通貨で表示されます。

GIG からの各応答は 1 時間キャッシュされるため、同じカートでも新たなリクエストは発生しません。失敗したリクエストまたは失敗したログインは 10 分間キャッシュされるため、チェックアウトは更新のたびに GIG Logistics の応答を待つ必要がありません。ログイントークンは 30 分間保持され、GIG が拒否した場合は自動的に更新されます。API のタイムアウトは 10 秒、住所検索のタイムアウトは 5 秒です。

GIG Logistics がエラーまたは 0 の料金を返した場合、購入者にエラーは表示されません。料金表またはフォールバック料金が使用され、エラーはデバッグログに記録されます。

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

モジュールは料金の計算のみを行います。GIG Logistics の出荷、送り状、ラベルは作成せず、集荷の予約、荷物の追跡、サービスセンターの選択は行いません。注文は通常どおり、お客様の GIG Logistics アカウントから出荷されます。リアルタイム料金は、ナイジェリアの住所に対してのみ問い合わせられます。その他の国では、料金表を使用してください。

ライセンスキー

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

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

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

トラブルシューティング

GIG Logistics がチェックアウトに表示されない: ライセンスが有効であること、Enable/Disable がオンであることを確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと購入者のグループをカバーしていることを確認するか、Ignore shipping zones をオンにして Countries を確認してください。重量制限と Minimum subtotal を確認してください。料金表(国または *)または Fallback cost で、その国の料金が設定されていることを確認してください。商品ページで、特定の配送業者のみに商品を制限することもできます。

料金が GIG Logistics ではなく料金表から取得されている: リアルタイム料金には、API のユーザー名とパスワード、Sender phone、集荷先の市区町村と州、市区町村または州を含むナイジェリアの配送先住所が必要です。デフォルト通貨が NGN でないショップでは、Currency conversion rate も必要です。設定ページ上部の警告を確認してください。Debug log をオンにしてチェックアウトを再読み込みし、モジュールページの Log の項目を確認すると、理由がわかります。失敗したリクエストは 10 分後に再試行されます。

ログに Login failed と表示される: GIG Logistics が API のユーザー名またはパスワードを拒否しました。これらを確認し、Test mode も確認してください。テスト用の認証情報はテスト API でのみ使用できます。設定を保存すると、すぐに再試行されます。

GIG Logistics が料金を返さない: GIG は距離に応じて料金を計算します。Address lookup をオンにしておくか、Pickup latitude と Pickup longitude を入力してください。Add Nigerian states をクリックすると、配送先の州も送信されます。本番運用の前に、GIG Logistics のアカウントで料金を確認してください。

集荷先の市区町村と州の警告が消えない: State で州を選択し、City / area を入力してください。ショップの住所は、ショップの国がナイジェリアの場合にのみ使用されます。ショップの州は、ナイジェリアの州を追加し、Shop Parameters > Contact > Stores で選択した後にのみ認識されます。

GIG の料金に税金が上乗せされる: GIG の料金に請求したい内容がすべて含まれている場合は、Tax を No tax に設定してください。

変更後に料金が古いように見える: モジュールのページで Save をクリックしてください。これにより、キャッシュされた料金、トークン、座標がクリアされます。

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

アンインストール

Modules > Module Manager に移動し、VibeFox GIG Logistics の横にあるメニューを開いて Uninstall を選択します。ライセンスキーとライセンスステータスは常に削除されます。キャッシュされた料金、トークン、住所の座標は常に削除されます。Remove data on uninstall がオンの場合、配送業者は削除され(注文は履歴を保持します)、設定とログも削除されます。オフの場合、配送業者は無効になるだけで、すべての設定が保持されます。モジュールを再インストールすると、保存されていた配送業者は以前のステータスに戻ります。Add Nigerian states で追加されたナイジェリアの州は、どちらの場合もショップに残ります。

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