VibeFox Chilexpress for PrestaShop — ヘルプ
要件
PrestaShop:8.0 から 9.x。
PHP:8.0 以降。実際の料金には cURL 拡張機能が必要です。古い PHP バージョンではモジュールをインストールできません。
Chilexpress API キー(実際の料金の場合のみ):Chilexpress 開発者ポータル(developers.wschilexpress.com)でアカウントを作成し、2 つの製品を購読してください:Rating(Cotizador)と Coverage(Coberturas / Georreferencia)。製品ごとに個別のサブスクリプションキーが発行されます。テストキーはテスト環境でのみ使用できます。本番キーは、Chilexpress と顧客契約を結んだ法人顧客に発行されます。また、発送元の comuna の Chilexpress county コード(例:STGO)も必要です。固定料金のみを使用する場合、API キーは不要です。
チリの地域(実際の料金の場合のみ):実際の料金には、配送先住所の地域が必要です。PrestaShop にはチリの地域が標準で含まれていませんが、モジュールで追加できます(下の Chilean regions を参照)。ストアに国 Chile が存在する必要があります。
VibeFox ライセンスキー:vibefox.net で購入します。1 つのキーは 1 つのドメインでのみ使用できます。
インストール
1. バックオフィスで Modules > Module Manager に移動し、Upload a module をクリックします。モジュールの ZIP ファイルを選択します。
2. アップロードが完了したら Configure をクリックします。後から行う場合は、モジュール一覧で VibeFox Chilexpress を探して Configure をクリックします。
3. Configure ページ上部のライセンスブロックにある License key に VibeFox ライセンスキーを貼り付け、Activate をクリックします(ライセンスキーを参照)。
4. Country prices の表を入力します。実際の料金を使う場合は、2 つのサブスクリプションキー、発送元の origin county コードを入力し、ストアの通貨が CLP でない場合は CLP の為替レートも入力します。ページに指示が表示された場合は Add Chilean regions をクリックします。次に料金ソースを選択し(設定を参照)、Save をクリックします。
インストール時に、モジュールは配送時間のテキスト Chilexpress courier を持つ Chilexpress 配送業者を作成します。この配送業者はチリのゾーンと、すべての顧客グループに関連付けられます。ゾーン、顧客グループ、配送時間、ロゴ、サイズ制限は Shipping > Carriers で変更できます。料金はそこで設定しないでください。料金は常にモジュールから取得されます。他のゾーンでも Chilexpress を提供するには、そのページで配送業者にゾーンを追加するか、Ignore shipping zones を有効にします。
設定
すべての設定はモジュールのページにあります:Modules > Module Manager > VibeFox Chilexpress > Configure。各セクションには個別の Save ボタンがあり、ページ全体が保存されます。保存するたびに、キャッシュされた Chilexpress の料金と comuna の一覧も消去されます。変更にはモジュールの "configure" 権限が必要です。権限がない場合、ページには You do not have permission to configure this module. と表示されます。
ページの上部には問題点が表示されます。API 料金が選択されているのにキー、origin county コード、CLP の為替レートのいずれかが未入力である場合、料金表にチリまたはデフォルトの行がない場合、ストアにチリの地域がない、またはチリの住所フォームに地域欄がない場合、ストアの重量または寸法の単位がモジュールで認識できない場合(その場合は kg または cm として読み取られます。International > Localization の Local units で設定してください)、配送業者が削除された場合です。数値はバックオフィスの言語に合わせて、小数点またはカンマで入力できます。無効な数値や負の数値、0 の CLP exchange rate、Max weight (kg) を上回る Min weight (kg)、64 文字を超える Name はエラーとなり、修正するまで何も保存されません。
全般
Enable/Disable:Chilexpress による配送を有効または無効にします。Shipping > Carriers にある配送業者のステータスと同じスイッチです。
Name:チェックアウトで購入者に表示される配送方法の名前です。配送業者の名前になります。デフォルト:Chilexpress。必須で、64 文字以内です。
Tax:配送業者の税ルール、または No tax(新しい配送業者のデフォルト)です。Chilexpress API の料金は見積もられた金額をそのまま使用します。見積もりに IVA がすでに含まれていて、ストアがその上にさらに税を加える場合は、No tax を選択してください。
料金
Rate source:料金の取得元です。
実際の料金はチリ国内の宛先にのみ適用されます。他の国では、常に固定料金が使われます。
Country prices:宛先の国の表です。Price 列と、任意のサイズ別料金があり、ストアのデフォルト通貨で税抜きで入力します。サイズはカートの重量から決まります:1 kg 以下は XS、2 kg 以下は S、3 kg 以下は M、5 kg 以下は L、5 kg 超は XL です。サイズを 0 のままにすると Price が使われます。Add country をクリックすると行を追加し、ゴミ箱アイコンをクリックすると行を削除します。* Default の行は、独自の行がない国に適用されます。行がない国(* Default もない場合)には固定料金がないため、その国では配送業者が非表示になります。料金とサイズ別料金がすべて 0 の行は、送料無料になります。表が空の場合は、チリの行が料金 0 で表示されます。最後の行は削除できず、0 にリセットするだけです。そのため、ページを保存する前に実際の料金を入力してください。重複した国や無効な料金は自動的に修正されます(重複は無視され、料金は 0 になります)。修正内容は警告に一覧表示されます。
Calculation type:Per order は固定料金を 1 回だけ請求します。Per item (fixed price x number of items) は、固定料金にカート内の商品数を掛けて請求します。Chilexpress API の料金は、常に荷物全体に対して見積もられます。
Chilexpress API(実際の料金)
このセクションの冒頭には、開発者ポータルと Rating および Coverage のサブスクリプションページへのリンクがあります。
Test environment:Chilexpress のテスト環境(qaservices.wschilexpress.com)を使用します。テストキーと併用し、実稼働のストアでは無効にしてください。
Rating API key:Rating(Cotizador)製品のサブスクリプションキーです。
Coverage API key:Coverage(Coberturas / Georreferencia)製品のサブスクリプションキーです。購入者の comuna の Chilexpress county コードを見つけるために使われます(住所の City 欄と、その地域を使用します)。
保存後、キー欄は空のままになり、Saved — leave empty to keep it. と表示されます。変更する場合にのみ新しい値を入力してください。キーは入力したとおりに保存されます。前後の空白だけが削除されます。
Remove the saved Rating API key および Remove the saved Coverage API key:保存されたキーがある場合にのみ表示されます。オンにして Save をクリックすると、キーが削除されます。
Origin county code:発送元の comuna の Chilexpress county コードです。2〜5 文字で、例として STGO(Santiago Centro)、PROV(Providencia)、VALP(Valparaíso)があります。インストール後は空です。county コードではない値は、エラーとして拒否されます。
Service:料金の計算に使われる Chilexpress のサービスです。宛先で提供されていない場合は、提供されている中で最安のサービスが使われます。
CLP exchange rate:Chilexpress はチリ・ペソで見積もります。ストアのデフォルト通貨が CLP でない場合にのみ必要です。その通貨での 1 CLP の価格を入力します(例:0.001)。設定しない場合、API の料金は使われません。ストアの通貨が CLP の場合は空欄のままにしてください。値は 0 より大きい必要があります。
Chilean regions:チリの comuna は地域ごとに検索されるため、実際の料金には住所の地域が必要です。ストアにチリの地域がない場合、この欄には Add Chilean regions ボタンが表示されます。このボタンを押すと、16 の地域がチリの州(ISO コード RM、VS など)として追加され、チリで "Contains states" が有効になり、チリの住所フォームに地域欄が追加されます。既に存在する地域(コードまたは名前で一致するもの)は、重複して追加されません。すべての設定が完了すると、この欄には地域の数とともに Chilean addresses have a region と表示されます。
利用可能性
Min weight (kg):配送業者が表示されるために必要なカートの最小重量です。0 は制限なしを意味します。
Max weight (kg):カートの重量がこの値を超えると、配送業者は非表示になります。デフォルト:25。0 は制限なしを意味します。空欄の場合は 25 kg として扱われます。Min weight (kg) をこの値より大きくすることはできません。
Minimum subtotal:カートの小計(配送が必要な商品、割引後、税抜き)がこの金額以上の場合にのみ、配送業者を表示します。常に表示する場合は空欄のままにしてください。
Ignore shipping zones:下の国のゾーンが配送業者に関連付けられていなくても、その国に対して配送業者を提供します。配送業者はすべてのゾーンに関連付けられ、後から作成されたゾーンも関連付けられます。オフにすると、配送業者は以前のゾーンに戻ります。
Countries:このモードの宛先の国です。ストアの有効な国の中から選択します。空欄にするとすべての国を許可します。この欄は Ignore shipping zones が有効な場合にのみ使用されます。
送料無料
Free shipping:送料無料のしきい値を有効にします。
Free shipping from:送料が無料になるカートの小計(配送が必要な商品、割引後、税抜き)です。Free shipping が有効な場合にのみ使われます。この場合、API へのリクエストは行われません。
詳細設定
Debug log:API リクエストと料金の計算結果を、モジュールのフォルダにある logs/vfd_chx_debug.log.php に書き込みます。このファイルはウェブから開くことはできません。このオプションがオフの場合でも、API のエラーは常に記録されます。API キーと購入者の住所は、記録されることはありません。
Log:デバッグログのサイズと最新のエントリを表示します。Clear log をクリックすると、ログが消去されます。
Remove data on uninstall:有効にすると、モジュールをアンインストールしたときに、すべてのモジュール設定、配送業者、キャッシュされた料金、ログ、注文とともに保存されたサービスが削除されます。オフにすると、再インストールに備えてすべて保持されます。注文そのものは常に保持されます。
チェックアウトでの動作
配送のステップで、PrestaShop はモジュールに Chilexpress の料金を問い合わせます。配送が必要な商品のみが対象です。バーチャル商品は重量を加算せず、小計にも含まれません。小計は、カートのルール(クーポン)を適用した後、税抜きで、ストアのデフォルト通貨により計算されます。モジュールはまず条件を確認します。許可された国(Ignore shipping zones との組み合わせ)、カートの重量、最低小計です。送料無料が適用される場合、料金は 0 となり、Chilexpress へのリクエストは送信されません。
チリの住所と API の料金ソースの場合、モジュールは住所の地域と City 欄の comuna を取得し、その地域の comuna 一覧から Chilexpress の county コードを検索します(Coverage API)。アクセント、空白、綴りのバリエーションは無視されるため、Ñuñoa と Nunoa は一致し、Santiago は Santiago Centro と一致します。City 欄に直接入力された county コードも受け付けられます。その後、モジュールは発送元と宛先の county コード、カートの重量(最低 0.1 kg)、荷物のサイズ(最も大きい商品の長さと幅、高さは積み重ねた合計)、そしてカートの小計(CLP 建て)を申告価額として Rating API に送信します。Chilexpress はそのサービスを返し、モジュールは選択されたサービスまたは最安のサービスを使用して、ペソ建ての金額をストアのデフォルト通貨に換算します。料金はその通貨の小数桁数に丸められ、購入者のカートの通貨で表示されます。
料金は 1 時間、comuna の一覧は 7 日間キャッシュされます。失敗したリクエストは 5 分間記憶されるため、遅い API や利用できない API によってチェックアウトの更新が遅くなることはありません。API のタイムアウトは 10 秒です。Chilexpress がエラーを返した場合、料金付きのサービスがない場合、comuna や地域が不明な場合でも、購入者にエラーは表示されません。API のみのモードでは配送業者が非表示になり、それ以外の場合は固定料金が使われます。理由はデバッグログに記録されます。
注文がある配送業者を Shipping > Carriers で編集すると、PrestaShop はその配送業者を新しいバージョンとして保存します。モジュールは新しいバージョンに自動的に従います。
モジュールが行うのは料金の計算のみです。発送伝票や運送依頼(OT)の作成、ラベルの印刷、集荷の予約、荷物の追跡は行いません。配送の手配は Chilexpress のアカウントで行ってください。購入者が Chilexpress の営業所を選ぶことはできず、comuna のセレクターもありません。購入者は標準の City 欄に comuna を入力します。国際配送には固定料金が使われます。
注文
Chilexpress の配送業者で注文が行われると、モジュールは料金の算出方法を保存します。バックオフィスの注文ページには Chilexpress のブロックが表示されます。このブロックには、Chilexpress service(実際の料金の場合は Chilexpress が見積もったサービス、例:Express)と、Price source(Live rate (Chilexpress Rating API)、Fixed price、または Free shipping)が含まれます。
ライセンスキー
モジュールは、vibefox.net で取得した VibeFox ライセンスキーで動作します。ライセンスブロック License — VibeFox Chilexpress は、Modules > Module Manager > VibeFox Chilexpress > Configure ページの最初のブロックで、設定より上にあります。キーを License key に貼り付けて Activate をクリックします。その後、ブロックにはキーが伏せ字で表示され、ステータス(例:ライセンスの有効期限日とドメイン)と、ステータスを再確認する Check now、別のキーを入力する Change key、このストアからキーを削除する Remove key のボタンが表示されます。その下には Product: presta-shipping-chilexpress の行と、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 のアカウントでドメインの枠を解放してください。
有効なキーがない場合、チェックアウトで購入者に Chilexpress の配送業者は表示されず、料金も計算されません。PrestaShop のフロントエンドは、バックオフィスにログインしていることを認識しないため、配送業者はあなたにも表示されません。購入前にモジュールを設定することはできますが、チェックアウトでテストすることはできません。Modules > Module Manager の Alerts タブにリマインダーが表示されます。既存の注文には影響しません。
ライセンスの有効期限が切れた場合も、モジュールは動作を続けますが、アップデートとサポートには更新が必要です。バックオフィスで作業している間、ステータスは自動的に再確認されます。キー入力後の最初の 14 日間は 1 日 1 回、その後は週に 1 回です。cron ジョブは不要です。モジュールをアンインストールまたはリセットすると、ライセンスキーとライセンスステータスは常に削除されます。
トラブルシューティング
チェックアウトに Chilexpress が表示されない:ライセンスが有効であること、Enable/Disable がオンであることを確認してください。Shipping > Carriers で、配送業者が購入者の国のゾーンと購入者のグループを対象としていることを確認してください(または Ignore shipping zones がオンで、その国が Countries に含まれていること)。重量制限と Minimum subtotal も確認してください。固定料金の場合は、その国または * Default に行があることを確認してください。商品ページで、商品が特定の配送業者に制限されている場合もあります。
チリへの配送料が本来は有料なのに無料になっている:Country prices のチリ(または * Default)の行で、Price とサイズ列が 0 になっています。料金を入力して Save をクリックしてください。
実際の料金が表示されず、代わりに固定料金が使われている:まず、モジュールのページ上部にある警告を確認してください。警告がない場合は Debug log をオンにし、チェックアウトを再読み込みして、モジュールのページにある Log 欄を確認してください。よくある原因は次のとおりです:住所に地域がない、または地域欄がない(Add Chilean regions を使用してください)、Chilexpress が認識できない comuna(City 欄と地域を確認してください)、別の製品または環境用のキーを使っている、Chilexpress の対象外の宛先である。
ログに HTTP 401 または 403 が表示される:サブスクリプションキーが誤っているか、無効になっているか、別の製品または環境のものです。テストキーは Test environment がオンの場合にのみ動作します。
通貨の異なるストアで API の料金が使われない:CLP exchange rate を入力してください。
API の料金に IVA は含まれていますか?Chilexpress が見積もったとおりに使用されます。ストアが配送料に税を加えていて、見積もりにすでに IVA が含まれている場合は、Tax を No tax に設定してください。
変更後に料金が古いように見える:モジュールのページで Save をクリックしてください。これにより、キャッシュされた料金と comuna の一覧が消去されます。
ページに "The Chilexpress carrier was not found" と表示される:配送業者が Shipping > Carriers で削除されています。Modules > Module Manager でモジュールをリセットすると、再作成されます。
ページに "The country Chile does not exist in this shop" と表示される:International > Locations > Countries でチリを追加または有効にしてから、Add Chilean regions を使用してください。
アンインストール
Modules > Module Manager に移動し、VibeFox Chilexpress の横にあるメニューを開いて、Uninstall を選択します。ライセンスキーとライセンスステータスは常に削除されます。キャッシュされた料金と comuna の一覧は常に削除されます。Remove data on uninstall がオンの場合、配送業者は削除され(注文の履歴は保持されます)、設定、ログ、注文とともに保存されたサービスが削除されます。オフの場合、配送業者は無効化されるだけで、すべての設定は保持されます。モジュールを再インストールすると、保存されていた配送業者が以前のステータスで復元されます。Add Chilean regions で追加したチリの地域は、ストアに残ります。
Chilexpress は各所有者の商標です。本モジュールは Chilexpress と提携しておらず、Chilexpress による承認もありません。
