戻る

VibeFox Coordinadora for OpenCart — ヘルプ

要件

OpenCart: 3.0.x(3.0.5.0 でテスト済み)または 4.0.2 以降(4.1.0.3 でテスト済み)。

PHP: 8.0 以降。

Coordinadora API キー(リアルタイム見積もりのみ): リアルタイム見積もりは、公式の Coordinadora プラグインも使用している Coordinadora の WooCommerce サービスを通じて、Coordinadora Cotizador から取得されます。Coordinadora は、有効な商業契約を結んだ顧客に API キーを発行します。Coordinadora のアカウントマネージャーに問い合わせるか、wc.coordinadora.com をご覧ください。発送元都市の 8 桁の DANE コードも必要です。キーがない場合、この方法は固定料金でのみ機能します。

商品:リアルタイム見積もりには、カート内のすべての商品に重量と 3 つの寸法(縦、横、高さ)が必要です。

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

インストール

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

OpenCart 3

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

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

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

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

5. API キー、発送元都市の DANE コード、そしてストアの既定の通貨が COP でなければ COP の為替レートを入力します。フォールバックとして、コロンビアの固定料金を少なくとも 1 つ追加します(設定を参照)。Enable Coordinadora をオンにして Save をクリックします。

6. 商品に重量と寸法が設定されていることを確認します。

OpenCart 4

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

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

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

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

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

設定

すべての設定は拡張機能のページにあります: Extensions > Extensions > Shipping > VibeFox Coordinadora > Edit。設定はすべてのジオゾーンに適用されます。Conditions で、この方法を 1 つのジオゾーンと国に限定できます。セクションは左側に並んでいます。下部の 1 つの Save ボタンで、ページを再読み込みせずにページ全体を保存します。保存後、Settings saved. Cached Coordinadora rates were cleared. と表示されます。数字は小数点またはカンマで入力できます(9,99 = 9.99)。設定の保存ができるのは、この拡張機能の変更権限を持つ管理者ユーザーだけです。

Name が空である、または 64 文字を超える、数値やテーブルの価格が無効または負である、COP per 1 unit of store currency が 0 である、Min weight (kg) が Max weight (kg) より大きい、または Sort order が整数ではない場合、何も保存されず、ページにエラーが一覧表示されます。

リアルタイム見積もりが機能しない場合や、この方法が非表示になる場合は、設定の上に警告が表示されます。Origin city (DANE code) が空または無効である、既定の通貨が COP ではないのに COP per 1 unit of store currency がない、コロンビア(または *)の固定料金がない、API キーもコロンビアの固定料金もないため、コロンビアの住所には決してこの方法が表示されない、などです。ストアに kg の重量クラスも cm の長さクラスもなく、既定の単位が拡張機能で認識されない場合にも警告が表示されます。その場合、商品の重量は kg、寸法は cm として読み取られます(System > Localisation で kg、g、lb、oz のいずれか、および cm、mm、m、in のいずれかを使用してください)。警告は保存のたびに更新されます。

一般

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

Name:チェックアウトで購入者に表示される配送方法の名前。既定値: Coordinadora。必須。64 文字まで。

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

Coordinadora のリアルタイム料金

リアルタイム見積もりは、コロンビア国内の宛先に対して請求されます。固定料金のみを使用する場合は、キーを空のままにしてください。

API key:Coordinadora の WooCommerce API キー。保存後、この欄は空のままになり、Saved — leave empty to keep it. と表示されます。変更したい場合にのみ、新しい値を入力してください。キーはログに書き込まれることはありません。

Remove the saved API key:キーが保存されている場合にのみ表示されます。オンにして Save をクリックするとキーが削除され、この方法は固定料金のみを使うようになります。

Origin city (DANE code):発送元都市の 8 桁の DANE コード。例: 11001000 Bogotá、05001000 Medellín、76001000 Cali、08001000 Barranquilla。5 桁の自治体コードも受け付けられ、8 桁に補完されます。

COP per 1 unit of store currency:Coordinadora はコロンビア・ペソで見積もります。既定の通貨が COP でない場合は、通貨 1 単位が何 COP に相当するかを入力します(例: 4300)。このレートは、申告価格を COP で送信するためにも使われます。空欄のままにすると、リアルタイム見積もりは使用されません。レートは 0 より大きい必要があります。既定の通貨が COP の場合は、空欄のままにします。

固定料金(API キーがない場合、コロンビア以外の宛先、およびリアルタイム見積もりが利用できない場合のフォールバックに使用されます)

Prices by country:国のリスト。Price の列と、任意の荷物サイズ別の料金(ストアの既定の通貨、税抜き)を含みます。サイズはカートの重量から決まります: XS は 1 kg まで、S は 1〜2 kg、M は 2〜3 kg、L は 3〜5 kg、XL は 5 kg 超。サイズ欄が 0 または空欄の場合は Price が使われます。Add country をクリックすると行が追加されます。新しい行はコロンビアから始まります。* All other countries は、独自の行がない国に適用されます。行がない国(* もない場合)には固定料金がありません。Price が 0 で、サイズ別の料金がない行は、送料無料になります。

Fixed price per:Order(既定値)は料金を 1 回だけ請求します。Item (price × quantity) は、カート内の商品数を掛けます。これは固定料金にのみ適用されます。Coordinadora のリアルタイム見積もりは、常に注文全体を対象とします。

条件

Min weight (kg):カートの重量がこの値未満の場合、この方法を非表示にします。0 は制限なし(既定値)。

Max weight (kg):カートの重量がこの値を超える場合、この方法を非表示にします。既定値: 25(欄が空の場合にも使われます)。0 は制限なし。

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

Free shipping:以下の小計からの送料無料をオンにします。

Free shipping from:送料が無料になる小計(クーポン適用後、税抜き)。Free shipping がオンの場合にのみ使用されます。この場合、API へのリクエストは行われません。

Tax class:配送料の税クラス、または No tax(既定値)。税クラスを選択すると、OpenCart は料金に配送税を加算します。料金または Coordinadora の見積もりに税が含まれている場合は、No tax を選択してください。

Geo zone:このジオゾーン内の住所に対してのみ Coordinadora を提供します。All zones(既定値)は制限なしを意味します。ジオゾーンは System > Localisation > Geo Zones で管理されます。

Countries:これらの宛先の国に対してのみ Coordinadora を提供します。空欄の場合はすべての国を許可します。この制限は Geo zone と併せて適用されます。

詳細設定

Debug log:料金計算を storage/logs/vfd_crd_debug.log.php(OpenCart 4 では system/storage/logs/vfd_crd_debug.log.php)に書き込みます。このファイルはウェブから読み取ることはできません。API のエラーと不完全な設定は、このオプションがオフでも常に記録されます。API キーと購入者の住所は記録されることはありません。ファイルが 5 MB に達すると、vfd_crd_debug.old.log.php に移動され、新しいログが開始されます。

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

Remove data on uninstall:オンにすると、拡張機能をアンインストールした際に、Coordinadora の設定、キャッシュされた見積もり、ログが削除されます。オフ(既定値)の場合は、再インストールのためにすべてが保持されます。

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

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

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

チェックアウト時の動作

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

API キーがあるコロンビアの住所の場合、拡張機能は次の順番で宛先都市の DANE コードを探します: City 欄の DANE コード(コロンビアの県と都市向けのチェックアウトモジュールが書き込みます。例: MEDELLIN (ANT) (05001000))、8 桁の郵便番号、または県庁所在地と約 40 の主要都市の内蔵リスト。住所に地域(県)がある場合、リストの都市はそれと照合されます。アクセント記号と大文字・小文字は無視されます。

次に、拡張機能は宛先の DANE コードと、各商品の発送元都市、重量(kg)、寸法(cm)、数量、申告価格(COP)を Coordinadora に送信します。申告価格は、クーポン割引適用後、税抜きの商品行の合計です。商品の重量と長さのクラスは自動的に換算されます。Coordinadora は COP で料金を返し、拡張機能はそれをストアの既定の通貨に換算し、その通貨の小数桁に丸め、選択された Tax class の税を加えて購入者の通貨で表示します。各見積もりは 1 時間キャッシュされます。失敗したリクエストは 10 分間記憶されるため、Coordinadora の障害がチェックアウトの更新を毎回遅延させることはありません。API のタイムアウトは 10 秒です。

リアルタイム見積もりが利用できない場合(API エラー、不明な都市、重量や寸法のない商品、不完全な設定)は、固定料金が使われます。固定料金もない場合、そのカートではこの方法は非表示になります。エラーの詳細はデバッグログに記録され、購入者に表示されることはありません。

拡張機能は料金の計算のみを行います。配送伝票やガイア(guías)の作成、ラベルの印刷、集荷(recogidas)の予約、荷物の追跡、代金引換(recaudo)の徴収、Droop の受け取りポイントの提供は行いません。これらには Coordinadora のポータルを使用してください。注文には何も追加されません。注文には、他の OpenCart 配送方法と同様に、配送方法名と送料が表示されます。国際的な宛先には固定料金が使われます。

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

ライセンスキー

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

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

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

トラブルシューティング

Coordinadora がチェックアウトに表示されない:ライセンスが有効で、Enable Coordinadora がオンになっていることを確認してください。拡張機能のページ上部の警告、Geo zone、Countries、重量の制限、Minimum order subtotal を確認します。リアルタイム見積もりがない場合は、その国または * に固定料金が必要です。商品の Requires Shipping が Yes になっていることを確認してください。

リアルタイム料金が表示されず、固定料金のみが表示される:Debug log をオンにし、チェックアウトを再読み込みして、拡張機能のページにある Log 欄を確認してください。よくある理由: 宛先都市が認識されない、商品に重量または寸法がない、発送元の DANE コードまたは COP の為替レートがない、Coordinadora がエラーを返した。

宛先都市が認識されない:City 欄に DANE コードを書き込む、コロンビアの県と都市向けのチェックアウトモジュールをインストールしてください。開発者は、OpenCart イベント vfd_coordinadora/dane_cities、vfd_coordinadora/destination_dane、vfd_coordinadora/api_url を使って都市を追加したり API のアドレスを変更したりできます。API のアドレスは、設定 vfd_crd_api_url(テスト用)でも置き換えられますが、この設定には設定ページにフィールドがありません。

料金に税は含まれていますか?料金は Coordinadora が見積もったものです。Tax class を設定すると、OpenCart は料金に配送税を加算します。見積もりにすでに税が含まれている場合は、No tax を選択してください。

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

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

アンインストール

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

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

Coordinadora は、各所有者の商標です。本拡張機能は Coordinadora とは提携しておらず、Coordinadora による推奨もされていません。