戻る

VibeFox iMile for WooCommerce — ヘルプ

要件

WordPress: 5.8 以降。

WooCommerce: 5.0 以降。インストールされ、有効化されている必要があります。WooCommerce がない場合、プラグインは有効化できません。

PHP: 8.0 以降。

iMile の料金体系: iMile の営業チームと合意した料金です。ストアの通貨で料金表に入力します。

iMile API アカウント(リアルタイム見積もりのみ): リアルタイム見積もりは、iMile OpenAPI の「Estimated order delivery costs」を使用します。Customer ID と Secret key(iMile が Customer ID と一緒に発行する API キー)が必要です。テスト用クライアントの場合は、iMile 開発者ポータル(developer.imile.com)に登録してください。本番用のキーは iMile のアカウント担当者から提供されます。料金表だけを使う場合、API キーは不要です。

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

インストール

1. WordPress で Plugins > Add New > Upload Plugin に移動し、プラグインの ZIP ファイルを選択して Install Now をクリックします。FTP で vfd_imile フォルダを /wp-content/plugins/ にアップロードすることもできます。

2. Activate をクリックします。

3. 設定を開きます。WooCommerce > Settings > Shipping > VibeFox iMile、または Plugins ページのプラグイン名の下にある Settings をクリックします。

4. ページ上部のライセンスブロックに VibeFox ライセンスキーを入力し、Activate をクリックします。

5. Price table に iMile の料金を入力します。必要に応じて Live rates (API) セクションに入力し、Live estimate を有効にします(「設定」を参照)。

6. WooCommerce > Settings > Shipping > Shipping zones で、配送ゾーン(例: 「United Arab Emirates」)に VibeFox iMile を追加するか、Ignore shipping zones を有効にして国を選択します。

設定

すべての設定は 1 つのページにあります: WooCommerce > Settings > Shipping > VibeFox iMile。設定はすべての配送ゾーンに適用されます。ゾーンにこの方法を追加すると、ゾーンのウィンドウには項目が 1 つだけ表示されます:

Title (zone): このゾーンで購入者に表示される名前。空欄の場合は、全体の Method title を使用します。

設定を保存するたびに、キャッシュされた iMile の見積もりとアクセストークンが削除されます。リアルタイム見積もりが有効でも動作できない場合(キーがない、出荷元の都市または国がない、為替レートがない、料金表が空)、設定の上部に警告が表示されます。

一般

Enable/Disable: すべてのゾーンでこの方法を一度に有効または無効にします。

Method title: カートとチェックアウトに表示される配送方法の名前。ゾーンごとに上書きできます。既定値: iMile。

リアルタイム料金(API)(任意)

iMile から見積もりが返されない場合(キーがない、都市が未入力、エラー、タイムアウト、為替レートがない)、料金表が使用されます。

Live estimate: 有効にすると、iMile から配送料金を取得します。既定値: 無効。リアルタイム見積もりが無効の場合、チェックアウト中に iMile へは何も送信されません。

Environment: Production (openapi.imile.com)(既定)または Test (test-openapi.52imile.cn)。テスト用のキーはテストサーバーでのみ動作し、テスト用の料金を返します。

Customer ID: iMile が発行するクライアントコード(customerId)。例: C2102192601。

Secret key: iMile が Customer ID と一緒に発行する秘密キー(API キー)。リクエストに署名するために使われます。

Signature: リクエストの署名方法。

MD5 signature (iMile API docs): 既定の設定です。
SimpleKey (the key itself, as the official iMile plugin does): ログに「sign is invalid」と表示された場合にのみ変更してください。

Ship-from country: 出荷元の国。既定ではストアの国です。リストには、プラグインが iMile の国コードを持つ国が含まれます。

Ship-from city: 荷物を出荷する都市。iMile の都市リストと同じ表記にしてください(例: Dubai、Riyadh)。空欄の場合は、WooCommerce > Settings > General で設定されたストアの都市を使用します。

Ship-from province: 任意。例: Dubai や Riyadh Province。

iMile service: iMile に送信される注文タイプ: Delivery order (100)(既定)または Express order (1100)。Express は、お使いのアカウントと国で有効になっている必要があります。

Goods category: iMile に送信される商品の種類: Normal goods(既定)、Sensitive (cosmetics, liquids...)、With battery、Batteries / power banks、Documents、または Parcel。

Exchange rates: iMile は配送先国の通貨で見積もりを返します。通貨ごとに 1 行ずつ、1 単位のストア通貨での価格を入力します。例: 「AED = 0.25」または「SAR = 0.24」。小数点区切りとしてピリオドとカンマのどちらも使えます。ストアの通貨自体にはレートは不要です。レートがない場合、その通貨の見積もりは使用されず、代わりに料金表が使われます。同じレートで、iMile に申告するカートの金額も換算します。無効な行は保存時に削除されます。

料金(リアルタイム見積もりが無効のとき、および iMile から見積もりが返されないときのフォールバックとして使用)

iMile の料金をストアの通貨で入力します。料金が AED、SAR、その他の通貨の場合は、先に換算してください。

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」のどちらも受け付けます。料金が入っていない行、無効な国コード、負の料金は、保存時に削除されます。国ごとに残るのは 1 行だけです。

Price for countries not in the table: ストアの通貨での料金。表に配送先の国の行がない(* の行もない)場合、またはその行にこの重量の料金がない場合に使用されます。この場合に方法を非表示にするには空欄のままにしてください。

Price applies: 料金表の料金の請求方法。

Per order (one parcel, tier by total cart weight): 料金は 1 回だけ請求され、カート全体の重量区分が使われます。
Per item (every item is a separate parcel, tier by its own weight): 各単位はそれぞれの重量区分で料金が計算され、料金が合算されます。

同じ選択肢がリアルタイム見積もりにも適用されます。注文単位ではカート全体を 1 個口として送信します。商品単位では、異なる荷物ごとに問い合わせを行い、個数を掛けます。カートに異なる荷物が 5 個を超える場合は、料金表が使用されます。

商品の重量は、ストアの重量単位からキログラムに換算されます。

条件

Minimum weight (kg): カートの重量がこれより軽い場合、この方法を非表示にします。0 は制限なしを意味します。

Maximum weight (kg): カートの重量がこれより重い場合、この方法を非表示にします。既定値: 30。0 は制限なしを意味します。

Minimum order amount: カートの小計(割引後、税抜き)がこの金額に達した場合にのみ、この方法を表示します。空欄の場合は常に表示します。

Free shipping from: カートの小計(割引後、税抜き)がこの金額以上の場合、iMile の配送が無料になります。空欄の場合は、送料無料を提供しません。

Excluded shipping classes: カートに、これらの WooCommerce 配送クラスのいずれかの商品が含まれている場合、この方法を非表示にします。

Tax status: Taxable は配送料に WooCommerce の税金を加算し、None は加算しません。料金表の料金と iMile の見積もりに消費税(VAT)がすでに含まれている場合は None を選択してください。

配送ゾーンを使わない場合の提供条件

Ignore shipping zones: この方法がどの配送ゾーンにも追加されていなくても、下記の国に対して iMile を提供します。

Countries: このモードの配送先の国。空欄の場合は、配送しているすべての国を使用します。この項目は、Ignore shipping zones が有効な場合にのみ使用されます。

詳細設定

Debug log: 料金計算を WooCommerce > Status > Logs(ソース「vfd_imile」)に書き込みます。キーや購入者の住所は記録されません。デバッグログがオフでも、失敗した iMile のリクエストは常に記録されます。作業が終わったら、ログをオフにしてください。

Remove data on uninstall: 有効な場合、プラグインを削除すると、すべての iMile 設定、ゾーンごとの方法、キャッシュされた見積もりが削除されます。プラグインを無効化しても、何も削除されません。

チェックアウト時の動作

購入者が配送先住所を入力すると、WooCommerce はプラグインに料金を問い合わせます。プラグインはまず条件を確認します。配送先の国、カートの重量、最低注文金額、除外する配送クラスです。送料無料が適用される場合、購入者は無料でこの方法を見ることができ、iMile へのリクエストは送信されません。

リアルタイム見積もりが有効な場合、プラグインは iMile に、出荷元の国、州/省、都市、配送先の国、州/県、都市、郵便番号、カートの重量(kg)、サイズ(cm³、商品の寸法から算出)、カートの金額、iMile のサービス、商品の種類を送信します。見積もりは常に前払いとして要求されるため、代金引換の手数料は含まれません。リアルタイム見積もりは、購入者が都市を入力した後で、かつすべての荷物に重量があるときにのみ要求されます。各応答は 1 時間キャッシュされます。失敗したリクエストは 5 分間キャッシュされます。タイムアウトまたはサーバーエラーの後は 2 分間、拒否されたキーの後は 5 分間、iMile への問い合わせを行いません。これにより、更新のたびにチェックアウトが iMile の応答を待つことがなくなります。API のタイムアウトは 12 秒です。期限切れのアクセストークンは自動的に更新されます。

見積もりは、為替レートを使ってストアの通貨に換算されます。iMile から利用可能な見積もりが返されない場合(キーが未設定、都市が未入力、都市が不明、エラー、タイムアウト、為替レートがない)、購入者にエラーは表示されず、料金表の料金が使用されます。料金表にも料金がなければ、この方法は非表示になります。理由はログに記録されます。

この方法は、クラシックチェックアウト、およびカートとチェックアウトのブロックで動作します。WooCommerce の高性能注文保存(HPOS)に対応しています。

プラグインが行うのは料金の計算だけです。iMile の出荷データの作成、AWB ラベルの印刷、集荷の依頼、荷物の追跡、代金引換の照合、受け取りポイントやロッカーの提供は行いません。出荷には iMile のポータルを使用してください。

ライセンスキー

プラグインは、vibefox.net で取得した VibeFox ライセンスキーを使用します。ライセンスブロックは WooCommerce > Settings > Shipping > VibeFox iMile の上部にあります。キーを License key に貼り付けて、Activate をクリックします。ブロックにはステータスが表示されます。例えば、ライセンスが有効な期限の日付やお使いのドメインです。Check now でステータスを再確認し、Change key で別のキーを入力し、Remove key でこのサイトからキーを削除します。Manage licenses and domains in your account のリンクから、vibefox.net のアカウントを開けます。

1 つのキーは 1 つのドメインで使用できます。サイトからキーを削除しても、ドメインの枠は解放されません。枠は vibefox.net のアカウントで解放してください。

有効なキーがない場合、チェックアウトで iMile は購入者に表示されません。ログインしているストアの管理者には、(unlicensed — visible to admins only) と表示された状態で引き続き表示されるため、キーを購入する前にプラグインの設定とテストができます。プラグインページと WooCommerce のページには通知が表示されます。既存の注文には影響しません。

ライセンスの期限が切れても、プラグインは動作し続けますが、アップデートとサポートには更新が必要です。ステータスは、バックグラウンドで自動的に再確認されます。

トラブルシューティング

チェックアウトに iMile が表示されない: ライセンスが有効であること、Enable/Disable がオンであること、この方法が購入者の国のゾーンに追加されていること(または Ignore shipping zones がオンで、その国が許可されていること)を確認してください。重量の制限、Minimum order amount、Excluded shipping classes も確認してください。国または * に Price table の行があるか、Price for countries not in the table が設定されているかを確認してください。

iMile の見積もりの代わりに料金表の料金が表示される: WooCommerce > Status > Logs を開き、ソースを「vfd_imile」にして、詳細を確認するために Debug log をオンにしてください。よくある原因は次のとおりです。Live estimate がオフ、キーがない、購入者がまだ都市を入力していない、iMile が都市名の表記を認識しない、商品に重量がない、配送先の通貨の為替レートがない、または API エラーです。設定の上部に表示される警告も確認してください。

ログに「sign is invalid」と表示される: Secret key を確認してから、Signature = SimpleKey を試してください。

キーが拒否される: Customer ID、Secret key、Environment を確認してください。テスト用のキーはテストサーバーでのみ動作します。

都市名が一致しない: 都市名は iMile の都市リストと一致している必要があります。開発者は vfd_imile_live_request フィルターで都市名を、vfd_imile_live_country_code フィルターで国コードを対応付けできます。

料金の通貨が違う: 料金表はストアの通貨(WooCommerce > Settings > General)で設定します。AED、SAR、MXN の料金は入力時に換算してください。リアルタイム見積もりは Exchange rates で換算されます。

配送料に税金が二重にかかる: 料金にすでに VAT(付加価値税)が含まれている場合は、Tax status を None に設定してください。

変更後に見積もりが古く見える: 設定ページを保存してください。これでキャッシュされた iMile の見積もりが削除されます。

ライセンスブロックにエラーが表示される: ブロックのメッセージに従ってください。例えば、キーが別のドメインで既に使用されている場合は、vibefox.net のアカウントで枠を解放してから Check now をクリックしてください。サイトのアドレスが変わった場合は、Check now をクリックして、新しいドメインでキーを有効にしてください。ライセンスサーバーに接続できない場合、プラグインは最後に確認されたステータスで動作を続けます。

アンインストール

プラグインを無効化しても、すべてのデータは保持されます。削除するには、無効化してから Plugins ページで削除してください。このプラグインのライセンスキーとライセンスステータスは、常に削除されます。設定、ゾーンごとの方法、キャッシュされた見積もりは、Remove data on uninstall が有効な場合にのみ削除されます。それ以外の場合は、再インストール時のために保持されます。既存の注文は、配送の行を保持します。

iMile は、それぞれの所有者の商標です。本プラグインは iMile と提携しておらず、iMile による推奨もありません。