戻る

VibeFox GIG Logistics for OpenCart — ヘルプ

動作要件

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

PHP:8.0 以降。

GIG Logistics API 認証情報(リアルタイム価格を使う場合のみ):リアルタイム価格は、GIG Logistics のサードパーティ API を使用します。GIG Logistics は法人のお客様に、API ユーザー名(通常はメールアドレス)とパスワードを発行します。GIG Logistics の開発者ページ(giglogistics.com/developer)で申請してください。テスト用の認証情報はテスト API でのみ有効です。価格表と予備の料金のみを使う場合は、API 認証情報は不要です。

ストアのナイジェリア:リアルタイム価格は、ナイジェリアの配送先住所に対してのみ要求されます。OpenCart にはナイジェリアの国が 37 州とともにすでに含まれていますが、System > Localisation > Countries で有効にしておく必要があります。

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

インストール

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

OpenCart 3

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

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

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

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

5. 価格表または予備の料金を入力します。リアルタイム価格を使う場合は、API のユーザー名とパスワード、集荷先の電話番号、番地、市区町村、州も入力し、基本通貨が NGN でない場合は通貨換算レートを入力してください(設定を参照)。Enable/Disable をオンにして、Save をクリックします。

OpenCart 4

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

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

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

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

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

設定

すべての設定は拡張機能のページにあります:Extensions > Extensions > Shipping > VibeFox GIG Logistics > Edit。セクションは左側に一覧表示されます。ページ下部の Save ボタン 1 つで、ページを再読み込みせずにページ全体を保存します。保存のたびに、キャッシュされた GIG Logistics の価格、API トークン、住所の座標も消去されます。この拡張機能の変更権限を持つ管理者ユーザーのみが設定を保存できます。

ページの上部には、保存のたびに、リアルタイム価格が使用できない場合の警告が表示されます。API のユーザー名またはパスワードの片方しか入力されていない、Sender phone または集荷先の市区町村や州が未入力、基本通貨が NGN で Currency conversion rate が設定されていない、などです。また、ストアに単位が kg の重量クラスがない場合(System > Localisation > Weight Classes)にも警告されます。その場合、商品の重量は単位名(kg、g、lb、oz)に従って換算され、それ以外の単位は kg として扱われます。保存時には、数値の誤り(負の金額、0 の Currency conversion rate、-90 から 90 の範囲外の緯度、-180 から 180 の範囲外の経度)、Max weight (kg) より大きい Min weight (kg)、空または無効な Method title、整数ではない並び順、不明な税クラスや地域ゾーンが報告され、何も保存されません。

全般

この配送方法は、Conditions で選択された地域ゾーン、または Ignore shipping zones の国に対して提供されます。このページの設定はすべてのゾーンに適用されます。

Enable/Disable:チェックアウトで GIG Logistics を表示するかどうかを設定します(この拡張機能のステータス)。初期値:オフ。

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

Tax class:送料の税クラス、または No tax です。税クラスを選ぶと、送料に配送税が上乗せされます。GIG の価格に、請求したい内容がすべて含まれている場合は、No tax を選択してください。

Sort order:配送方法の中でのこの方法の位置です。整数で指定します。

GIG Logistics API(リアルタイム価格)(任意)

API 認証情報を入力すると、ナイジェリアの住所ごとに GIG Logistics から価格を取得し、1 時間キャッシュします。認証情報がない場合、または API が価格を返さない場合は、価格表と予備の料金が使用されます。このセクションには、GIG Logistics の開発者ページへのリンクがあります。

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

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

Test mode:GIG Logistics のテスト(dev)API を使用します。テスト用の認証情報はテスト API でのみ有効です。実際の価格を使う場合はオフにしてください。初期値:オフ。

Currency conversion rate:GIG Logistics は価格を NGN で返します。ストアの基本通貨が NGN でない場合は、1 NGN が基本通貨でいくらの価値があるかを入力します(1 NGN = ? 基本通貨、例:0.0006)。レートは 0 より大きい必要があります。入力しないと、GIG のリアルタイム価格は使用されません。基本通貨が NGN の場合、この欄にはその旨が表示され、入力は不要です。

集荷先(差出人)住所

ナイジェリアで GIG Logistics が荷物を集荷する場所です。OpenCart には構造化されたストア住所がないため、ここに番地と市区町村を入力してください。ストアの国がナイジェリアの場合、空欄の State は System > Settings > Store > Local のストアの地域を使用します。

Sender name:GIG Logistics に送信される差出人名です。空欄の場合はストア名が使用されます。

Sender phone:お客様の電話番号です。例:08030000000。リアルタイム価格には GIG Logistics が必須としています。

Street address:集荷先の番地です。例:1 Adeola Odeku Street。

City / area:集荷先の市区町村または地域です。例:Victoria Island。リアルタイム価格には必須です。

State:集荷先住所のナイジェリアの州で、37 州から選択します。初期値の Store region (System > Settings > Store > Local) は、ストアがナイジェリアにある場合にストアの地域を使用します。リアルタイム価格には必須です。

Pickup latitude:集荷地点の地図上の緯度です(任意)。例:6.4281。GIG Logistics は距離に基づいて価格を決めます。空欄の場合、住所から座標を検索します。

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

Address lookup:OpenStreetMap(Nominatim)を使って、住所の地図上の座標を取得します。GIG Logistics は、集荷先と配送先の座標から価格を計算します。お客様の番地、市区町村、州は nominatim.openstreetmap.org に送信され、結果は 30 日間キャッシュされます。この設定がオフの場合は住所のテキストのみが送信され、GIG Logistics が価格を返さない場合があります。初期値:オン。

価格表と予備の料金

他の国の場合、リアルタイム価格が設定されていない場合、または 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 として保存されるため、追加した各行には基本価格を入力してください。保存後、修正された値は Country prices: で始まる警告に一覧表示されます。行のない国(* の行がない場合)には、表からの価格は適用されません。

Fallback cost:GIG Logistics も表も価格を返さなかった場合に使用されます。空欄の場合、その状況では配送方法は非表示になります。

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

条件

Free shipping from:送料が無料になるカートの小計です(配送が必要な商品、クーポン適用後、税抜き)。空欄の場合、送料無料にはなりません。

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

Min weight (kg):カートの最小重量(kg)です。商品の重量は、その重量クラスに従って換算されます。0 は制限なしを意味します。

Max weight (kg):カートの最大重量(kg)です。初期値:30。0 は制限なしを意味します。

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

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

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

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

詳細設定

Debug log:価格の計算を storage/logs/vfd_gigl_debug.log.php(OpenCart 4 では system/storage/logs/vfd_gigl_debug.log.php)に書き込みます。このファイルはウェブから読み取ることはできません。ログがオフでも、API と住所検索のエラーは常に記録されます。パスワード、トークン、お客様の住所は書き込まれません。ファイルが 5 MB に達すると、vfd_gigl_debug.old.log.php に移動され、新しいログが開始されます。

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

Remove data on uninstall:オンにすると、拡張機能をアンインストールした際に、設定とログが削除されます。オフの場合は、再インストール用にすべてが保持されます。キャッシュされた価格は常に削除されます。注文は常に保持されます。

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

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

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

チェックアウト時の動作

OpenCart が配送方法を表示するとき、拡張機能に GIG Logistics の価格を問い合わせます。Geo zone が設定されていて(かつ Ignore shipping zones がオフの)、住所がその範囲外の場合、この配送方法は提供されません。Requires Shipping が Yes に設定されている商品のみが計算対象になります。それ以外の商品は重量に加算されず、小計にも含まれません。小計とは、これらの商品の、クーポン割引後、税抜きの価格です。ギフトカード、ポイント、ストアクレジットは考慮されません。拡張機能はまず条件を確認します:配送先の国(Ignore shipping zones を使う場合)、カートの重量、最低小計です。小計が Free shipping from に達している場合、価格は 0 になり、GIG Logistics へのリクエストは送信されません。

次に、価格は価格を提供できる最初の情報源から取得されます。まず GIG Logistics のリアルタイム価格です。これは、API 認証情報が入力されていて、住所がナイジェリアにあり、住所に市区町村または州があり、集荷先の電話番号、市区町村、州が設定されていて、基本通貨が NGN でないストアの場合は換算レートが設定されている場合に使用されます。拡張機能は GIG Logistics API にログインし、集荷先と配送先の住所と座標、カートの商品の名前、数量、重量、価値を送信します。重量のない商品は 1 kg として送信されます。価格はバイク配送として要求されます。次に Country prices の表です。3 番目は Fallback cost です。どの情報源も価格を提供しない場合、そのカートでは配送方法は非表示になります。価格は基本通貨で計算され、その小数点以下の桁数に丸められ、選択した Tax class の税額を含めて、お客様の通貨で表示されます。

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

GIG Logistics がエラーまたは 0 の価格を返した場合、お客様にエラーは表示されません。表の価格または予備の料金が使用され、エラーはデバッグログに記録されます。

拡張機能は価格の計算のみを行います。GIG Logistics の配送伝票、送り状、ラベルの作成、集荷の予約、荷物の追跡は行わず、お客様がサービスセンターを選ぶこともできません。注文には何も追加されません。注文には、他のすべての OpenCart の配送方法と同様に、配送方法の名前と送料が表示されます。リアルタイム価格はナイジェリアの住所に対してのみ要求されます。他の国では、価格表を使用してください。

OpenCart 4 では、お客様はチェックアウトページの配送方法ブロックで Choose をクリックし、Shipping method options のウィンドウで GIG Logistics を選択します。そのウィンドウでは、配送方法の名前と価格が表示されます(例:GIG Logistics - $4.50)。この配送方法は OpenCart 3 と同じように動作します。

ライセンスキー

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

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

1 つのキーは 1 つのドメインで有効です。OpenCart の設定にあるストアのアドレスが対象です。ストアからキーを削除しても、ドメインの枠は解放されません。vibefox.net のアカウントで枠を解放してください。

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

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

トラブルシューティング

GIG Logistics がチェックアウトに表示されない:ライセンスが有効であること、Enable/Disable がオンであることを確認してください。Geo zone、または Ignore shipping zones と Countries、重量制限、Minimum subtotal を確認してください。価格表(国または *)または Fallback cost が、その国の価格を提供していることを確認してください。商品の Requires Shipping が Yes に設定されていることも確認してください。

価格が GIG Logistics からではなく、価格表から来ている:リアルタイム価格には、API のユーザー名とパスワード、Sender phone、集荷先の市区町村と州、市区町村または州のあるナイジェリアの配送先住所、そして基本通貨が NGN でないストアの場合は Currency conversion rate が必要です。Edit ページの上部の警告を確認してください。Debug log をオンにして、チェックアウトを再読み込みし、拡張機能ページの Log 欄を確認すると、理由が分かります。失敗したリクエストは 10 分後に再試行されます。

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

GIG Logistics が価格を返さない:GIG は距離に基づいて価格を決めます。Address lookup をオンのままにするか、Pickup latitude と Pickup longitude を入力してください。本番運用を開始する前に、GIG Logistics のアカウントで価格を確認してください。

集荷先の市区町村と州の警告が消えない:State で州を選択し、City / area を入力してください。ストアの地域は、System > Settings > Store > Local のストアの国がナイジェリアの場合にのみ使用されます。

GIG の価格に税金が加算される:GIG の価格に、請求したい内容がすべて含まれている場合は、Tax class を No tax に設定してください。

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

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

開発者向け:GIG Logistics API のアドレスと住所検索のアドレスは、設定 vfd_gigl_api_base_url と vfd_gigl_geocode_url(テスト用)で置き換えることができます。これらの設定には設定ページに入力欄はありません。

アンインストール

Extensions > Extensions に進み、種類 Shipping を選択して、VibeFox GIG Logistics の横にある Uninstall(赤い − ボタン)をクリックします。この拡張機能のライセンスキーとライセンスステータスは常に削除されます。OpenCart は常に Enable/Disable、Sort order、Tax class、Geo zone をリセットします。キャッシュされた価格、トークン、住所の座標は常に削除されます。Remove data on uninstall がオンの場合、その他の設定とデバッグログも削除されます。オフの場合、それらは保持され、拡張機能を再インストールしたときに再び使用されます。既存の注文は、配送方法と送料を保持します。

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

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